{ "openapi": "3.0.1", "info": { "title": "BILLmanager API" }, "servers": [ { "url": "http://localhost:1500/billmgr" } ], "components": { "securitySchemes": { "SessionAuth": { "type": "apiKey", "name": "ISP_AUTHORIZATION", "in": "header", "description": "Enter the token with the `Bearer` prefix, e.g. `Bearer 9698eff6c576ed85f5b57875`" } }, "schemas": { "OutFormat": { "type": "string", "enum": [ "bjson" ], "default": "bjson" }, "LocaleElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "langcode": { "type": "string", "description": "Language ISO code " }, "status": { "type": "string", "description": "Информация по локализации и ее статусе" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Localization is active \"; value \"off\": \"Localization is not used \"" }, "embedded": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Built-in localization \"" }, "default_lang": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Default localization \"" } } }, "LocaleNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter the localization name (for example: French)", "example": "text" }, "langcode": { "type": "string", "description": "Enter the language code that will be used for identifying localized messages", "example": "text" } } }, "Locale": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter the localization name (for example: French)", "example": "text" }, "langcode": { "type": "string", "description": "Enter the language code that will be used for identifying localized messages", "example": "text" } } }, "LocaleSetdefault": { "type": "object", "properties": {} }, "CurrencyElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "iso": { "type": "string", "description": "Enter the currency code according to ISO" }, "code": { "type": "string", "description": "Currency code according to ISO" }, "status": { "type": "string", "description": "Currency status in BILLmanager " }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Enabled \"; value \"off\": \"Disabled \"" } } }, "CurrencyNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter a currency name", "example": "text" }, "iso": { "type": "string", "description": "ISO code", "example": "text" }, "symbol": { "type": "string", "description": "UTF symbol of the currency ", "example": "" }, "code": { "type": "string", "description": "ISO number", "example": "1" } } }, "Currency": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter a currency name", "example": "text" }, "iso": { "type": "string", "description": "ISO code", "example": "text" }, "symbol": { "type": "string", "description": "UTF symbol of the currency ", "example": "" }, "code": { "type": "string", "description": "ISO number", "example": "1" } } }, "CurrencyRelateElem": { "type": "object", "properties": { "relate": { "type": "string", "description": "Currency name" }, "iso": { "type": "string", "description": "Enter the currency ISO code " }, "ratedate": { "type": "string", "description": "Date of the last update " }, "rate": { "type": "string", "description": "Exchange rate dynamics" }, "status": { "type": "string", "description": "Currencies can be uploaded automatically " }, "autoupload": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Enabled \"; value \"off\": \"Disabled\"" } } }, "CurrencyrateElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "ratedate": { "type": "string", "description": "Date of the rate change" }, "rate": { "type": "string", "description": "Currency rate on the selected date " } } }, "CurrencyrateNew": { "type": "object", "properties": { "ratedate": { "type": "string", "description": "Start date of the exchange rate ", "example": "text" }, "amount": { "type": "string", "description": "Number of items of the base currency", "example": "1" }, "rate": { "type": "string", "description": "Set the exchange rate for the date and units provided above ", "example": "1.00" } } }, "Currencyrate": { "type": "object", "properties": { "ratedate": { "type": "string", "description": "Start date of the exchange rate ", "example": "text" }, "amount": { "type": "string", "description": "Number of items of the base currency", "example": "1" }, "rate": { "type": "string", "description": "Set the exchange rate for the date and units provided above ", "example": "1.00" } } }, "CurrencyrateUpload": { "type": "object", "properties": { "autoupload": { "type": "string", "enum": [ "on", "off" ], "description": "Exchange rate will be uploaded automatically ", "example": "off" }, "autotime": { "type": "string", "description": "Enter the upload time (hh:mm). A cron job will start every day at this time to update exchange rates", "example": "text" }, "upload": { "type": "string", "enum": [ "on", "off" ], "description": "Update exchange rates with parameters specified below ", "example": "off" }, "multi": { "type": "string", "description": "Multiply the uploaded currency rate by the value from this field ", "example": "0.0" }, "sum": { "type": "string", "description": "Increase the uploaded currency rate by the value from this field ", "example": "0.0" }, "fromdate": { "type": "string", "description": "Upload data starting from the selected date. Otherwise data will be uploaded from the last update date", "example": "" }, "rewrite": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to overwrite the data saved in the system if the same date is used", "example": "off" } } }, "CurrencyUpload": { "type": "object", "properties": {} }, "ProjectElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"off\": \"The provider is temporary disabled. Authentication, order, renewal and other operations are blocked \"" }, "currency_str": { "type": "string", "description": "Select the main currency for this provider ", "example": "EUR" }, "site": { "type": "string", "description": "Enter the URL to the provider's web-site " }, "billurl": { "type": "string", "description": "URL to BILLmanager, which is used to identify a provider when registering a new client " } } }, "ProjectNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter a provider's name that will be used in notifications, and invoices for clients ", "example": "text" }, "small_img_upload": { "type": "string", "description": "Upload icon 16х16", "example": "" }, "notifyemail": { "type": "string", "description": "Enter the email address to send notifications ", "example": "example@domain.com" }, "supportemail": { "type": "string", "description": "It is used in notification about activation of user/payer account and password recovery", "example": "example@domain.com" }, "site": { "type": "string", "description": "Enter the URL to your web-site. It can be used in notifications for users ", "example": "http://example.com" }, "billurl": { "type": "string", "description": "Enter the URL to BILLmanager. It can be used in notifications for users ", "example": "http://example.com" }, "clienthelp": { "type": "string", "description": "Enter a URL of the page that will open when a user clicks the \"Help\" menu. The {lang} macro allows to open different pages depending on user's localization ", "example": "http://example.com" }, "basecurrency": { "type": "string", "description": "Select a currency. If you change it, new client invoices will be generated in new currency ", "example": "" }, "country_default": { "type": "string", "description": "Default country. It will be selected if a country cannot be defined by the saved value or IP address ", "example": "74" }, "state_default": { "type": "string", "description": "Default region. It will be selected if a region cannot be defined by the saved value", "example": "" }, "auth_method_phone": { "type": "string", "enum": [ "on", "off" ], "description": "By phone number", "example": "off" }, "PhoneAuthCheckTry": { "type": "string", "description": "Number of code entry attempts, if the specified limit is reached, a new code must be obtained", "example": "1" }, "PhoneAuthSendTry": { "type": "string", "description": "The number of attempts to receive the phone number confirmation code when going through the verification procedure", "example": "1" }, "auth_method_vkontakte": { "type": "string", "enum": [ "on", "off" ], "description": "VKontakte", "example": "off" }, "auth_method_google": { "type": "string", "enum": [ "on", "off" ], "description": "Google", "example": "off" }, "recaptcha_type": { "type": "string", "enum": [ "3", "0", "1", "2" ], "description": "reCAPTCHA settings on the registation form for provider ; 3 - use Invisible reCAPTCHA; 0 - global settings ; 1 - do not use ; 2 - use reCAPTCHA", "example": "" }, "recaptcha_publickey": { "type": "string", "description": "reCAPTCHA public key", "example": "text" }, "recaptcha_privatekey": { "type": "string", "description": "reCAPTCHA secret key", "example": "text" }, "recaptcha_auth_publickey": { "type": "string", "description": "reCAPTCHA public key", "example": "text" }, "recaptcha_auth_privatekey": { "type": "string", "description": "reCAPTCHA secret key", "example": "text" }, "recaptcha_auth_excluded_ips": { "type": "string", "description": "List of IP addresses and/or IP address ranges for which the reCAPTCHA check will not be performed", "example": "" }, "autoassignitem": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to add the selected service for free to a client's account when assigning him to this provider ", "example": "off" }, "closeaccounts": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to close clients' invoices when the period specified above is over", "example": "off" }, "period_lenght": { "type": "string", "description": "Set the period that will pass before clinets' invoices are closed", "example": "0" }, "period_type": { "type": "string", "enum": [ "1", "2", "3" ], "description": "Period ; 1 - Day; 2 - Month; 3 - Year", "example": "" }, "description": { "type": "string", "description": "Expense description", "example": "text" }, "activeitem": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to close clients' inovices even if he has active services", "example": "off" }, "ga_version4": { "type": "string", "enum": [ "on", "off" ], "description": "Use Google Analytics 4 instead of Universal Analytics (Google Analytics 3)", "example": "off" }, "ga_counter": { "type": "string", "description": "Google Analytics data stream ID (in G-YQXYQ1YQ23 format)", "example": "" }, "ga_secret": { "type": "string", "description": "Private key for Measurement Protocol", "example": "" }, "ga_userid": { "type": "string", "enum": [ "on", "off" ], "description": "Send a User ID to Google ", "example": "off" }, "ga_type": { "type": "string", "description": "Export will be based on expenses or services. Based on expenses - information about all clients' expenses will be exported. Based on services - information will be exported per service only once, regardless its expenses ", "example": "" }, "ga_trial": { "type": "string", "enum": [ "on", "off" ], "description": "Show information about trial licenses ", "example": "off" }, "ym_counter": { "type": "string", "description": "Id counter for Yandex.Metrics ", "example": "" } } }, "Project": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter a provider's name that will be used in notifications, and invoices for clients ", "example": "text" }, "small_img_upload": { "type": "string", "description": "Upload icon 16х16", "example": "" }, "notifyemail": { "type": "string", "description": "Enter the email address to send notifications ", "example": "example@domain.com" }, "supportemail": { "type": "string", "description": "It is used in notification about activation of user/payer account and password recovery", "example": "example@domain.com" }, "site": { "type": "string", "description": "Enter the URL to your web-site. It can be used in notifications for users ", "example": "http://example.com" }, "billurl": { "type": "string", "description": "Enter the URL to BILLmanager. It can be used in notifications for users ", "example": "http://example.com" }, "clienthelp": { "type": "string", "description": "Enter a URL of the page that will open when a user clicks the \"Help\" menu. The {lang} macro allows to open different pages depending on user's localization ", "example": "http://example.com" }, "basecurrency": { "type": "string", "description": "Select a currency. If you change it, new client invoices will be generated in new currency ", "example": "" }, "country_default": { "type": "string", "description": "Default country. It will be selected if a country cannot be defined by the saved value or IP address ", "example": "74" }, "state_default": { "type": "string", "description": "Default region. It will be selected if a region cannot be defined by the saved value", "example": "" }, "auth_method_phone": { "type": "string", "enum": [ "on", "off" ], "description": "By phone number", "example": "off" }, "PhoneAuthCheckTry": { "type": "string", "description": "Number of code entry attempts, if the specified limit is reached, a new code must be obtained", "example": "1" }, "PhoneAuthSendTry": { "type": "string", "description": "The number of attempts to receive the phone number confirmation code when going through the verification procedure", "example": "1" }, "auth_method_vkontakte": { "type": "string", "enum": [ "on", "off" ], "description": "VKontakte", "example": "off" }, "auth_method_google": { "type": "string", "enum": [ "on", "off" ], "description": "Google", "example": "off" }, "recaptcha_type": { "type": "string", "enum": [ "3", "0", "1", "2" ], "description": "reCAPTCHA settings on the registation form for provider ; 3 - use Invisible reCAPTCHA; 0 - global settings ; 1 - do not use ; 2 - use reCAPTCHA", "example": "" }, "recaptcha_publickey": { "type": "string", "description": "reCAPTCHA public key", "example": "text" }, "recaptcha_privatekey": { "type": "string", "description": "reCAPTCHA secret key", "example": "text" }, "recaptcha_auth_type": { "type": "string", "enum": [ "0", "3", "2", "1" ], "description": "Configure reCAPTCHA on the login form for provider ; 0 - global settings; 3 - use Invisible reCAPTCHA; 2 - use reCAPTCHA; 1 - do not use", "example": "" }, "recaptcha_auth_publickey": { "type": "string", "description": "reCAPTCHA public key", "example": "text" }, "recaptcha_auth_privatekey": { "type": "string", "description": "reCAPTCHA secret key", "example": "text" }, "recaptcha_auth_excluded_ips": { "type": "string", "description": "List of IP addresses and/or IP address ranges for which the reCAPTCHA check will not be performed", "example": "" }, "licenseserverprovider": { "type": "string", "description": "Provide a license server for ordering control panels for services ", "example": "" }, "autoassignitem": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to add the selected service for free to a client's account when assigning him to this provider ", "example": "off" }, "autoassignpricelist": { "type": "string", "description": "Tariff associates with the service you want to set up ", "example": "" }, "autoassignperiod": { "type": "string", "description": "Select a period for this service ", "example": "" }, "closeaccounts": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to close clients' invoices when the period specified above is over", "example": "off" }, "period_lenght": { "type": "string", "description": "Set the period that will pass before clinets' invoices are closed", "example": "0" }, "period_type": { "type": "string", "enum": [ "1", "2", "3" ], "description": "Period ; 1 - Day; 2 - Month; 3 - Year", "example": "" }, "description": { "type": "string", "description": "Expense description", "example": "text" }, "activeitem": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to close clients' inovices even if he has active services", "example": "off" }, "ga_version4": { "type": "string", "enum": [ "on", "off" ], "description": "Use Google Analytics 4 instead of Universal Analytics (Google Analytics 3)", "example": "off" }, "ga_counter": { "type": "string", "description": "Google Analytics data stream ID (in G-YQXYQ1YQ23 format)", "example": "" }, "ga_secret": { "type": "string", "description": "Private key for Measurement Protocol", "example": "" }, "ga_userid": { "type": "string", "enum": [ "on", "off" ], "description": "Send a User ID to Google ", "example": "off" }, "ga_type": { "type": "string", "description": "Export will be based on expenses or services. Based on expenses - information about all clients' expenses will be exported. Based on services - information will be exported per service only once, regardless its expenses ", "example": "" }, "ga_trial": { "type": "string", "enum": [ "on", "off" ], "description": "Show information about trial licenses ", "example": "off" }, "ym_counter": { "type": "string", "description": "Id counter for Yandex.Metrics ", "example": "" } } }, "ProjectLocaleElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "status": { "type": "string" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Localization is active\"; value \"off\": \"Localization is not used\"" }, "embedded": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Built-in localization\"" }, "default_locale": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"It is used by default\"" } } }, "ProjectCompanyElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "status": { "type": "string" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" } } }, "ProjectCompany": { "type": "object", "properties": { "payment_description": { "type": "string", "description": "Enter the purpose of default advance payment that will be displayed in the list of payments ", "example": "" } } }, "ProjectSupport": { "type": "object", "properties": {} }, "ProjectTaxruleElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "company": { "type": "string" }, "country": { "type": "string", "description": "Payer country" }, "taxrate": { "type": "string", "description": "Tax rate" }, "itemtype": { "type": "string", "description": "Product type " }, "startdatetime": { "type": "string", "description": "Start date of the tax rate " }, "enddatetime": { "type": "string", "description": "End date of the tax rate " } } }, "ProjectTaxruleNew": { "type": "object", "properties": { "company": { "type": "string", "enum": [ "null" ], "description": "; null - -- All --", "example": "" }, "country": { "type": "string", "description": "Select a country. A newly created tax rule will be applied to payers from this country ", "example": "" }, "state": { "type": "string", "enum": [ "null" ], "description": "If a two-layer tax system is used, you can add a federal (all) tax and state tax, which will be summed up ; null - -- All --", "example": "" }, "taxrate": { "type": "string", "description": "Enter a tax rate for the selected country", "example": "text" }, "timezone": { "type": "string", "description": "Select a time zone", "example": "" }, "startdatetime": { "type": "string", "description": "Start date of the tax rate ", "example": "" }, "enddatetime": { "type": "string", "description": "End date of the tax rate ", "example": "" }, "specialitemtype": { "type": "string", "enum": [ "on", "off" ], "description": "Taxes are imposed only on particular product types ", "example": "off" }, "itemtype": { "type": "string", "description": "Select product types to impose a tax ", "example": "" } } }, "ProjectTaxrule": { "type": "object", "properties": { "company": { "type": "string", "enum": [ "null" ], "description": "; null - -- All --", "example": "" }, "country": { "type": "string", "description": "Select a country. A newly created tax rule will be applied to payers from this country ", "example": "" }, "state": { "type": "string", "enum": [ "null" ], "description": "If a two-layer tax system is used, you can add a federal (all) tax and state tax, which will be summed up ; null - -- All --", "example": "" }, "taxrate": { "type": "string", "description": "Enter a tax rate for the selected country", "example": "text" }, "timezone": { "type": "string", "description": "Select a time zone", "example": "" }, "startdatetime": { "type": "string", "description": "Start date of the tax rate ", "example": "" }, "enddatetime": { "type": "string", "description": "End date of the tax rate ", "example": "" }, "specialitemtype": { "type": "string", "enum": [ "on", "off" ], "description": "Taxes are imposed only on particular product types ", "example": "off" }, "itemtype": { "type": "string", "description": "Select product types to impose a tax ", "example": "" } } }, "ProjectTaxruleSettings": { "type": "object", "properties": { "taxexclusive": { "type": "string", "enum": [ "on", "off" ], "description": "Select this check box to add a tax to product's price. Tax rates limited by company to which payments are made, cannot be used ", "example": "off" }, "taxcustompay": { "type": "string", "enum": [ "on", "off" ], "description": "Show the tax amount when a client adds funds to his account. This is an obligatory option only for specific countries. Learn tax regulations for your country ", "example": "off" } } }, "ProjectGroupElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier" }, "name": { "type": "string", "description": "Group title" }, "status": { "type": "string" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" } } }, "ProjectGroupNew": { "type": "object", "properties": { "name": { "type": "string", "example": "" }, "allow_same_phone": { "type": "string", "enum": [ "on", "off" ], "description": "Select this option to allow clients to specify the same phone number for verification on different accounts ", "example": "off" } } }, "ProjectGroup": { "type": "object", "properties": { "name": { "type": "string", "example": "" }, "allow_same_phone": { "type": "string", "enum": [ "on", "off" ], "description": "Select this option to allow clients to specify the same phone number for verification on different accounts ", "example": "off" } } }, "ProjectItemtypeElem": { "type": "object", "properties": { "name": { "type": "string", "description": "Entity name" }, "orderpriority": { "type": "string", "description": "Select product type sorting " } } }, "ProjectCurrencyElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "iso": { "type": "string", "description": "Enter the international currency code", "example": "EUR" }, "status": { "type": "string" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" }, "projectdefault": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"It is used by default\"" } } }, "CompanyElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" } } }, "CompanyAddNew": { "type": "object", "properties": { "country_legal": { "type": "string", "description": "Select a country where your legal entity is registered. Document and data types available to the company will very depending on the selected country. You can modify the list of documents in the \"Countries\" module ", "example": "74" }, "profiletype": { "type": "string", "enum": [ "1", "2", "3", "1", "2", "3" ], "description": "Legal status of the company ; 1 - Individual; 2 - Company; 3 - Sole proprietor; 1 - Individual; 2 - Company; 3 - Sole proprietor", "example": "" }, "name": { "type": "string", "description": "Enter a company name", "example": "text" }, "email": { "type": "string", "description": "Enter the company's email", "example": "example@domain.com" }, "www": { "type": "string", "description": "Enter the URL of the company's web-site. It can be used in print templates ", "example": "http://example.com" }, "fax": { "type": "string", "description": "Enter the fax number", "example": "" }, "phone": { "type": "string", "description": "Enter the phone number", "example": "" }, "payment_description": { "type": "string", "description": "Enter a purpose of advance payments", "example": "" }, "state_legal": { "type": "string", "description": "Region where the company is registered ", "example": "" }, "postcode_legal": { "type": "string", "description": "Enter the zip code of the company's registration address", "example": "" }, "city_legal": { "type": "string", "description": "Enter the city where the company is registered", "example": "" }, "country_physical": { "type": "string", "description": "Select a country where the company is located ", "example": "" }, "state_physical": { "type": "string", "description": "Region where the company is located ", "example": "" }, "postcode_physical": { "type": "string", "description": "Enter the zip code of the city where this company is located ", "example": "" }, "city_physical": { "type": "string", "description": "Enter the city where the company is located ", "example": "" }, "regdate": { "type": "string", "description": "Enter the date when the company was founded", "example": "" }, "locale": { "type": "string", "description": "Language that is used for documents", "example": "" }, "doctmpl_payment": { "type": "string", "description": "Template of the invoice that can be printed. It can be modified in the payment methods edit form", "example": "" }, "numtmpl_payment": { "type": "string", "description": "The template of the invoice number. You can use the following macros: {id} - payment id and {num} - invoice numerical number. If both macros are not present, {num} will be used ", "example": "" }, "nextnum_payment": { "type": "string", "description": "Enter the next numerical number of the payment. This value is taken into account only if you specified invoice number template and didn't specify a template in the payment method edit form ", "example": "1" }, "doctmpl_invoice": { "type": "string", "enum": [ "correction", "correction" ], "description": "Select an invoice print template; correction - Correction invoice template; correction - Correction invoice template", "example": "" }, "numtmpl_invoice": { "type": "string", "description": "Invoice number template. You can use the macros {id} - invoice id, and {num} - invoice numerical order. If both macros are not present, the {num} macro will be used ", "example": "" }, "nextnum_invoice": { "type": "string", "description": "Enter the next order number of the invoice ", "example": "1" }, "doctmpl_invoice_correction": { "type": "string", "description": "The print template of the correction invoice generated by the company", "example": "" }, "numtmpl_invoice_correction": { "type": "string", "description": "Invoice number template. You can use the macros {id} - invoice id, and {num} - invoice numerical order. If both macros are not present, the {num} macro will be added to the template ", "example": "" }, "nextnum_invoice_correction": { "type": "string", "description": "The next numerical number of the correction invoice generated by the company. It will be taken into account provided that the invoice number template is specified", "example": "1" }, "doctmpl_envelope": { "type": "string", "description": "Template of the envelope", "example": "" }, "doctmpl_reconciliation": { "type": "string", "description": "Select a reconciliation report template. You can add or edit it in the \"Document templates\" module. If you do not select a template, your users won't be able to create a reconciliation report", "example": "" }, "sendcostcurrency": { "type": "string", "description": "Select currency of the cost of sending documents ", "example": "" }, "sendcost": { "type": "string", "description": "The cost of sending documents by post. The billing system will add a corresponding expense ", "example": "" } } }, "Company": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter a company name", "example": "text" }, "email": { "type": "string", "description": "Enter the company's email", "example": "example@domain.com" }, "www": { "type": "string", "description": "Enter the URL of the company's web-site. It can be used in print templates ", "example": "http://example.com" }, "fax": { "type": "string", "description": "Enter the fax number", "example": "" }, "phone": { "type": "string", "description": "Enter the phone number", "example": "" }, "payment_description": { "type": "string", "description": "Enter a purpose of advance payments", "example": "" }, "country_legal": { "type": "string", "description": "Select a contry where the company is registered", "example": "" }, "state_legal": { "type": "string", "description": "Region where the company is registered ", "example": "" }, "postcode_legal": { "type": "string", "description": "Enter the zip code of the company's registration address", "example": "" }, "city_legal": { "type": "string", "description": "Enter the city where the company is registered", "example": "" }, "country_physical": { "type": "string", "description": "Select a country where the company is located ", "example": "" }, "state_physical": { "type": "string", "description": "Region where the company is located ", "example": "" }, "postcode_physical": { "type": "string", "description": "Enter the zip code of the city where this company is located ", "example": "" }, "city_physical": { "type": "string", "description": "Enter the city where the company is located ", "example": "" }, "regdate": { "type": "string", "description": "Enter the date when the company was founded", "example": "" }, "locale": { "type": "string", "description": "Language that is used for documents", "example": "" }, "doctmpl_payment": { "type": "string", "description": "Template of the invoice that can be printed. It can be modified in the payment methods edit form", "example": "" }, "numtmpl_payment": { "type": "string", "description": "The template of the invoice number. You can use the following macros: {id} - payment id and {num} - invoice numerical number. If both macros are not present, {num} will be used ", "example": "" }, "nextnum_payment": { "type": "string", "description": "Enter the next numerical number of the payment. This value is taken into account only if you specified invoice number template and didn't specify a template in the payment method edit form ", "example": "1" }, "doctmpl_invoice": { "type": "string", "enum": [ "correction" ], "description": "Select an invoice print template; correction - Correction invoice template", "example": "" }, "numtmpl_invoice": { "type": "string", "description": "Invoice number template. You can use the macros {id} - invoice id, and {num} - invoice numerical order. If both macros are not present, the {num} macro will be used ", "example": "" }, "nextnum_invoice": { "type": "string", "description": "Enter the next order number of the invoice ", "example": "1" }, "doctmpl_invoice_correction": { "type": "string", "description": "The print template of the correction invoice generated by the company", "example": "" }, "numtmpl_invoice_correction": { "type": "string", "description": "Invoice number template. You can use the macros {id} - invoice id, and {num} - invoice numerical order. If both macros are not present, the {num} macro will be added to the template ", "example": "" }, "nextnum_invoice_correction": { "type": "string", "description": "The next numerical number of the correction invoice generated by the company. It will be taken into account provided that the invoice number template is specified", "example": "1" }, "doctmpl_envelope": { "type": "string", "description": "Template of the envelope", "example": "" }, "doctmpl_reconciliation": { "type": "string", "description": "Select a reconciliation report template. You can add or edit it in the \"Document templates\" module. If you do not select a template, your users won't be able to create a reconciliation report", "example": "" }, "sendcostcurrency": { "type": "string", "description": "Select currency of the cost of sending documents ", "example": "" }, "sendcost": { "type": "string", "description": "The cost of sending documents by post. The billing system will add a corresponding expense ", "example": "" } } }, "CompanyContractElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "contracttype": { "type": "string", "description": "Contract type " }, "doctmpl_name": { "type": "string", "description": "Contract template" } } }, "CompanyContractNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the contract example ", "example": "text" }, "contracttype": { "type": "string", "enum": [ "1", "2", "0", "1", "2", "0" ], "description": "Select a contract type ; 1 - Offer ; 2 - Affiliate program agreement ; 0 - Service agreement ; 1 - Offer ; 2 - Affiliate program agreement ; 0 - Service agreement ", "example": "" }, "accepttype": { "type": "string", "enum": [ "1", "2", "0" ], "description": "Select how you want your clients to read and accepts the offer ; 1 - During registration ; 2 - During payment ; 0 - During registration and payment ", "example": "" }, "itemtype": { "type": "string", "description": "A client will be asked to sign a contract if he has the selected services", "example": "" }, "show_pricelist": { "type": "string", "example": "" }, "pricelist": { "type": "string", "description": "If the client has services of the corresponding tariff plans, he will be offered to sign the contract", "example": "" }, "accountgroup": { "type": "string", "description": "This contract will be available for the selected client group", "example": "" }, "accountgroups_restrict": { "type": "string", "description": "This contract is not available for the selected client group", "example": "" }, "profiletype": { "type": "string", "enum": [ "1", "2", "3", "1", "2", "3" ], "description": "Select a payer status; 1 - Individual; 2 - Company; 3 - Sole proprietor; 1 - Individual; 2 - Company; 3 - Sole proprietor", "example": "" }, "for_each_item": { "type": "string", "enum": [ "on", "off" ], "description": "A separate contract will be created for every service of the client", "example": "off" }, "non_standard": { "type": "string", "enum": [ "on", "off" ], "description": "The text of a non-standard contract is created by a staff member and is attached to the client's contract as a separate file", "example": "off" }, "doctmpl": { "type": "string", "description": "Contract template. You can create and edit it in the \"Document templates\" module", "example": "" }, "suffix": { "type": "string", "description": "This suffix will be added to the contract number. The contract number is generated as follows: PAYER_ID + SUFFIX. E.g. payer id - 1, suffix - '/contract'. The contract number will look like '1/contract'. If a standard contract is created for every service, you can specify a the contract id '__id__' in the suffix. Eg. if the suffix is '/__id__/contract', the contract number will be '1/2/contract'", "example": "" }, "numbertmpl": { "type": "string", "description": "Template by which the numbering of contracts will be generated. Date designation in a specified format and macros is supported. More details in the documentation", "example": "" }, "start_date": { "type": "string", "description": "The contract won't be generated automatically after this date", "example": "" }, "end_date": { "type": "string", "description": "After this date the contract won't be generated for clients ", "example": "" } } }, "CompanyContract": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the contract example ", "example": "text" }, "contracttype": { "type": "string", "enum": [ "1", "2", "0", "1", "2", "0" ], "description": "Select a contract type ; 1 - Offer ; 2 - Affiliate program agreement ; 0 - Service agreement ; 1 - Offer ; 2 - Affiliate program agreement ; 0 - Service agreement ", "example": "" }, "accepttype": { "type": "string", "enum": [ "1", "2", "0" ], "description": "Select how you want your clients to read and accepts the offer ; 1 - During registration ; 2 - During payment ; 0 - During registration and payment ", "example": "" }, "itemtype": { "type": "string", "description": "A client will be asked to sign a contract if he has the selected services", "example": "" }, "show_pricelist": { "type": "string", "example": "" }, "pricelist": { "type": "string", "description": "If the client has services of the corresponding tariff plans, he will be offered to sign the contract", "example": "" }, "accountgroup": { "type": "string", "description": "This contract will be available for the selected client group", "example": "" }, "accountgroups_restrict": { "type": "string", "description": "This contract is not available for the selected client group", "example": "" }, "profiletype": { "type": "string", "enum": [ "1", "2", "3", "1", "2", "3" ], "description": "Select a payer status; 1 - Individual; 2 - Company; 3 - Sole proprietor; 1 - Individual; 2 - Company; 3 - Sole proprietor", "example": "" }, "for_each_item": { "type": "string", "enum": [ "on", "off" ], "description": "A separate contract will be created for every service of the client", "example": "off" }, "non_standard": { "type": "string", "enum": [ "on", "off" ], "description": "The text of a non-standard contract is created by a staff member and is attached to the client's contract as a separate file", "example": "off" }, "doctmpl": { "type": "string", "description": "Contract template. You can create and edit it in the \"Document templates\" module", "example": "" }, "suffix": { "type": "string", "description": "This suffix will be added to the contract number. The contract number is generated as follows: PAYER_ID + SUFFIX. E.g. payer id - 1, suffix - '/contract'. The contract number will look like '1/contract'. If a standard contract is created for every service, you can specify a the contract id '__id__' in the suffix. Eg. if the suffix is '/__id__/contract', the contract number will be '1/2/contract'", "example": "" }, "numbertmpl": { "type": "string", "description": "Template by which the numbering of contracts will be generated. Date designation in a specified format and macros is supported. More details in the documentation", "example": "" }, "start_date": { "type": "string", "description": "The contract won't be generated automatically after this date", "example": "" }, "end_date": { "type": "string", "description": "After this date the contract won't be generated for clients ", "example": "" } } }, "CompanyContractAppendixElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "doctmpl_name": { "type": "string" } } }, "CompanyContractAppendixNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter the name for the contract annex", "example": "text" }, "project": { "type": "string", "description": "This annex will be generated, if a client has services of the selected type", "example": "" }, "itemtype": { "type": "string", "description": "This annex will be generated, if a client has services of the selected type", "example": "" }, "nocheck": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box if you don't want the billing system to check that a client has this service before generating a contract appendix ", "example": "off" }, "doctmpl": { "type": "string", "description": "Annex template. You can add and modify it in the \"Document templates\" module", "example": "" } } }, "CompanyContractAppendix": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter the name for the contract annex", "example": "text" }, "project": { "type": "string", "description": "This annex will be generated, if a client has services of the selected type", "example": "" }, "itemtype": { "type": "string", "description": "This annex will be generated, if a client has services of the selected type", "example": "" }, "nocheck": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box if you don't want the billing system to check that a client has this service before generating a contract appendix ", "example": "off" }, "doctmpl": { "type": "string", "description": "Annex template. You can add and modify it in the \"Document templates\" module", "example": "" } } }, "CompanyProjectElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "status": { "type": "string" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" } } }, "AccountElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "email": { "type": "string", "description": "Client's email address" }, "project": { "type": "string", "description": "Providers that the client can be assigned to" }, "balance": { "type": "string", "description": "Account balance" }, "account_status": { "type": "string", "description": "Current financial status of this client " }, "tz_registration_date": { "type": "string", "description": "Customer registration date " }, "status": { "type": "string", "description": "Client properties" }, "has_discount": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Client has personal discounts \"" }, "aneed_phone": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Requires phone verification \"" }, "aneed_activation": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Email confirmation required\"" }, "aneed_manual_vetting": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Requires manual check \"" }, "tax_warning": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"The client is assigned to several groups with tax rates. Conflicts may occur.\"" } } }, "AccountNew": { "type": "object", "properties": { "username": { "type": "string", "description": "Enter a login. Leave the field blank if you want to use Email to log in", "example": "" }, "email": { "type": "string", "description": "Enter the email address that a client will use to login to BILLmanager", "example": "example@domain.com" }, "verify_email": { "type": "string", "enum": [ "on", "off" ], "description": "Send an email to confirm the email address", "example": "off" }, "project": { "type": "string", "description": "Select a provider this client will be assigned to", "example": "" }, "client_lang": { "type": "string", "description": "The language that will be set for the client after registration ", "example": "" }, "country": { "type": "string", "description": "Client country ", "example": "" }, "state": { "type": "string", "description": "Select a region ", "example": "" }, "realname": { "type": "string", "description": "Enter a customer name, or company's contact person name", "example": "" }, "firstname": { "type": "string", "description": "Enter a customer first name, or company's contact person first name", "example": "text" }, "lastname": { "type": "string", "description": "Enter a customer last name, or company's contact person last name", "example": "text" }, "passwd": { "type": "string", "description": "Enter a password to access BILLmanager", "example": "" }, "confirm": { "type": "string", "example": "" }, "employee": { "type": "string", "description": "Select a staff member who registered this client", "example": "" }, "notify": { "type": "string", "enum": [ "on", "off" ], "description": "Send the Client registration notification ", "example": "off" }, "recovery": { "type": "string", "enum": [ "on", "off" ], "description": "Add password reset information into Notifications ", "example": "off" } } }, "Account": { "type": "object", "properties": { "country": { "type": "string", "description": "Client country ", "example": "" }, "state": { "type": "string", "description": "Select a region ", "example": "" }, "name": { "type": "string", "description": "Enter a client name", "example": "text" }, "valid_phone": { "type": "string", "description": "Enter the verified phone number", "example": "" }, "try_phone": { "type": "string", "description": "Enter the client's phone number", "example": "" }, "try_count_phone": { "type": "string", "description": "The number of attempts to confirm the client's phone number ", "example": "" }, "label": { "type": "string", "description": "This information will be available only in filters ", "example": "" }, "products_page": { "type": "string", "description": "Page ", "example": "" }, "registration_date": { "type": "string", "description": "Registration date", "example": "" }, "registration_ip": { "type": "string", "description": "The client was registered from this IP address", "example": "" }, "attitude": { "type": "string", "enum": [ "0", "1", "2", "0", "1", "2" ], "description": "Characteristics of a client. This will help you work with him; 0 - Common; 1 - Good; 2 - Problematic; 0 - Common; 1 - Good; 2 - Problematic", "example": "" }, "abuse_rate": { "type": "string", "description": "The number of abuse scores ", "example": "" }, "employee": { "type": "string", "description": "Select a staff member who registered this client", "example": "" } } }, "AccountGroupElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "status": { "type": "string", "description": "Indicates that the client is assigned into a certain group" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" }, "has_tax": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Tax rates are set for the client group\"" } } }, "AccountOrdersElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Order name " }, "project": { "type": "string", "description": "Provider under which the order was placed " }, "status": { "type": "string", "description": "Order status " } } }, "AccountOrdersProjectOrder": { "type": "object", "properties": { "project": { "type": "string", "description": "Provider name", "example": "" } } }, "AccountOrdersProjectCart": { "type": "object", "properties": { "project": { "type": "string", "description": "Provider name", "example": "" } } }, "AccountOrders": { "type": "object", "properties": {} }, "AccountProjectElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "status": { "type": "string", "description": "Status" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" } } }, "SubaccountElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "project": { "type": "string", "description": "Provider associated with this account" }, "balance": { "type": "string", "description": "Account balance " }, "creditlimit": { "type": "string", "description": "The maximum amount of money that a client is allowed to use in addition to the funds on his personal account" }, "status": { "type": "string" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" } } }, "SubaccountNew": { "type": "object", "properties": { "subaccount_project": { "type": "string", "description": "Provider associated with this account", "example": "" }, "subaccount_currency": { "type": "string", "description": "Currency of this account", "example": "" }, "allowpostpaid": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to allow post-paid services for the client", "example": "off" }, "creditlimit": { "type": "string", "description": "Credit limit allows a client to buy services on credit within the amount specified ", "example": "" }, "count_from": { "type": "string", "enum": [ "1", "0", "2" ], "description": "When to start the counting; 1 - from the date of the due payment; 0 - unlimited; 2 - from the last invoice", "example": "" }, "postponement_days": { "type": "string", "description": "The number of days when the client must pay off the debt", "example": "1" }, "block_after_days": { "type": "string", "description": "The number of days that will pass before order and renewal of services will be blocked", "example": "1" }, "referer": { "type": "string", "description": "Enter the id of the client who referred this client", "example": "" }, "active": { "type": "string", "enum": [ "on", "off" ], "description": "This account is active. A client may have only one active account registered with a certain provider", "example": "off" } } }, "Subaccount": { "type": "object", "properties": { "allowpostpaid": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to allow post-paid services for the client", "example": "off" }, "creditlimit": { "type": "string", "description": "Credit limit allows a client to buy services on credit within the amount specified ", "example": "" }, "count_from": { "type": "string", "enum": [ "1", "0", "2" ], "description": "When to start the counting; 1 - from the date of the due payment; 0 - unlimited; 2 - from the last invoice", "example": "" }, "postponement_days": { "type": "string", "description": "The number of days when the client must pay off the debt", "example": "1" }, "block_after_days": { "type": "string", "description": "The number of days that will pass before order and renewal of services will be blocked", "example": "1" }, "referer": { "type": "string", "description": "Enter the id of the client who referred this client", "example": "" }, "active": { "type": "string", "enum": [ "on", "off" ], "description": "This account is active. A client may have only one active account registered with a certain provider", "example": "off" }, "incident_limit": { "type": "string", "description": "Total number of support tickets used by the client over the whole period ", "example": "1" } } }, "SubaccountRefund": { "type": "object", "properties": { "paymethod": { "type": "string", "description": "Select a payment method to make a refund ", "example": "" }, "refundrule": { "type": "string", "description": "Add refund rules ", "example": "" }, "payment": { "type": "string", "description": "Select a payment for refund", "example": "" }, "amount": { "type": "string", "description": "Enter the amount to be refunded", "example": "1.00" } } }, "AccountDiscountElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "products": { "type": "string", "description": "Applies to goods/services" }, "value": { "type": "string", "description": "Discount can be configured either in percent or as a specific price." }, "actiontype": { "type": "string", "description": "Select a discount type. Please note, that discount given on renewal cannot be given on tariff plans with daily charges " }, "applicable_for": { "type": "string", "description": "Discount application method" }, "project": { "type": "string", "description": "A discount will be given to services of the selected provider " }, "discount_type": { "type": "string", "description": "Select a discount type " }, "period": { "type": "string", "description": "Discount validity period " } } }, "AccountDiscountAddNew": { "type": "object", "properties": { "project": { "type": "string", "description": "Select a provider associated with this discount", "example": "" }, "clientname": { "type": "string", "description": "Name to be displayed under the client. If it is not set, \"Discount\" or \"Special Price\" will be displayed depending on the type of discount", "example": "" }, "fromdate": { "type": "string", "description": "First date of the discount ", "example": "text" }, "todate": { "type": "string", "description": "Last day of the discount\n", "example": "text" }, "type": { "type": "string", "enum": [ "0", "1", "0", "1" ], "description": "Select a discount type; 0 - Percentage discount; 1 - Special price; 0 - Percentage discount; 1 - Special price", "example": "" }, "percentage": { "type": "string", "description": "Discount in % on product/service", "example": "0.0" }, "priority": { "type": "string", "description": "By default, discounts set for a client personally have a higher priority than discounts specified in promotions. If you set a discount to a negative priority, it will be applied only if there are no matching discounts from promotions", "example": "1" }, "actiontype": { "type": "string", "enum": [ "2", "0", "1", "2", "0", "1" ], "description": "Select a discount type. Please note, that discount given on renewal cannot be given on tariff plans with daily charges ; 2 - Renewal; 0 - Order and renewal; 1 - Order; 2 - Renewal; 0 - Order and renewal; 1 - Order", "example": "" }, "applicable_for": { "type": "string", "enum": [ "2", "1", "0", "2", "1", "0" ], "description": "Discount application method; 2 - To additional resources; 1 - To the base cost of the tariff; 0 - To the total cost of the service; 2 - To additional resources; 1 - To the base cost of the tariff; 0 - To the total cost of the service", "example": "" }, "period": { "type": "string", "enum": [ "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60" ], "description": "This discount will be given on selected periods; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years", "example": "" }, "account_uselimit": { "type": "string", "description": "Specify how many times the client can use the discount", "example": "1" }, "hide_from_client": { "type": "string", "enum": [ "on", "off" ], "description": "The discount will not be displayed to the client in the list of discounts and in calculations", "example": "off" } } }, "AccountDiscount": { "type": "object", "properties": { "clientname": { "type": "string", "description": "Name to be displayed under the client. If it is not set, \"Discount\" or \"Special Price\" will be displayed depending on the type of discount", "example": "" }, "fromdate": { "type": "string", "description": "First date of the discount ", "example": "text" }, "todate": { "type": "string", "description": "Last day of the discount\n", "example": "text" }, "type": { "type": "string", "enum": [ "0", "1", "0", "1" ], "description": "Select a discount type; 0 - Percentage discount; 1 - Special price; 0 - Percentage discount; 1 - Special price", "example": "" }, "percentage": { "type": "string", "description": "Discount in % on product/service", "example": "0.0" }, "priority": { "type": "string", "description": "By default, discounts set for a client personally have a higher priority than discounts specified in promotions. If you set a discount to a negative priority, it will be applied only if there are no matching discounts from promotions", "example": "1" }, "actiontype": { "type": "string", "enum": [ "2", "0", "1", "2", "0", "1" ], "description": "Select a discount type. Please note, that discount given on renewal cannot be given on tariff plans with daily charges ; 2 - Renewal; 0 - Order and renewal; 1 - Order; 2 - Renewal; 0 - Order and renewal; 1 - Order", "example": "" }, "applicable_for": { "type": "string", "enum": [ "2", "1", "0", "2", "1", "0" ], "description": "Discount application method; 2 - To additional resources; 1 - To the base cost of the tariff; 0 - To the total cost of the service; 2 - To additional resources; 1 - To the base cost of the tariff; 0 - To the total cost of the service", "example": "" }, "period": { "type": "string", "enum": [ "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60" ], "description": "This discount will be given on selected periods; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years", "example": "" }, "account_uselimit": { "type": "string", "description": "Specify how many times the client can use the discount", "example": "1" }, "hide_from_client": { "type": "string", "enum": [ "on", "off" ], "description": "The discount will not be displayed to the client in the list of discounts and in calculations", "example": "off" } } }, "AccountCurrencyrateElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "currency_base": { "type": "string", "description": "Select a base currency for conversion " }, "rate": { "type": "string", "description": "Currency rate as of the selected date for the selected number of items" }, "ratedate": { "type": "string", "description": "Start date of the exchange rate " } } }, "AccountCurrencyrateNew": { "type": "object", "properties": { "currency_base": { "type": "string", "description": "Select a base currency for conversion ", "example": "" }, "currency_relate": { "type": "string", "description": "Currency that will be converted to a base currency ", "example": "" }, "rate": { "type": "string", "description": "Currency rate as of the selected date for the selected number of items", "example": "0.0" }, "amount": { "type": "string", "description": "Number of items of the base currenct that this currency rate is created for ", "example": "1" }, "ratedate": { "type": "string", "description": "Start date of the exchange rate ", "example": "text" } } }, "AccountCurrencyrate": { "type": "object", "properties": { "currency_base": { "type": "string", "description": "Select a base currency for conversion ", "example": "" }, "currency_relate": { "type": "string", "description": "Currency that will be converted to a base currency ", "example": "" }, "rate": { "type": "string", "description": "Currency rate as of the selected date for the selected number of items", "example": "0.0" }, "amount": { "type": "string", "description": "Number of items of the base currenct that this currency rate is created for ", "example": "1" }, "ratedate": { "type": "string", "description": "Start date of the exchange rate ", "example": "text" } } }, "SubaccountExpenseElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "locale_name": { "type": "string", "description": "Expense name" }, "realdate": { "type": "string", "description": "Date when funds were charged for the service provided" }, "cdate": { "type": "string", "description": "Service activation date" }, "amount": { "type": "string", "description": "Amount that was debited" }, "notpayd": { "type": "string", "description": "Not paid " }, "discountamount": { "type": "string", "description": "Discount that was given to the client when charging his account " }, "payments": { "type": "string", "description": "Numbers of payments associated with this expense" }, "discount": { "type": "string", "description": "Id of the client's discount " }, "taxamount": { "type": "string", "description": "Tax amount" } } }, "SubaccountExpenseNew": { "type": "object", "properties": { "subaccount": { "type": "string", "description": "Choose a provider ", "example": "" }, "item": { "type": "string", "description": "Select a service", "example": "" }, "operation": { "type": "string", "description": "Expense will be generated based on the selected operation", "example": "" }, "amount": { "type": "string", "description": "Expense amount", "example": "1.00" }, "taxrate": { "type": "string", "description": "Tax rate. Note: tax amount is included into expense. Tax amount will be calculated as follows: AMOUNT - (AMOUNT / (100 + RATE) / 100) ", "example": "" }, "cdate": { "type": "string", "description": "Service activation date", "example": "text" }, "name": { "type": "string", "description": "Enter any name you want to use, otherwise the name will be generated automatically based on the operation selected above ", "example": "" }, "postpaid": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to provide services on credit in case of insufficient funds on client's account", "example": "off" } } }, "SubaccountExpense": { "type": "object", "properties": { "amount": { "type": "string", "description": "Expense amount", "example": "1.00" }, "taxrate": { "type": "string", "description": "Tax rate. Note: tax amount is included into expense. Tax amount will be calculated as follows: AMOUNT - (AMOUNT / (100 + RATE) / 100) ", "example": "" }, "realdate": { "type": "string", "description": "Date when the client was charged for the service", "example": "text" }, "cdate": { "type": "string", "description": "Service activation date", "example": "text" }, "name": { "type": "string", "description": "Enter any name you want to use, otherwise the name will be generated automatically based on the operation selected above ", "example": "" } } }, "ExpensePaymentElem": { "type": "object", "properties": { "payment": { "type": "string", "description": "The id of the payment associated with the expense " }, "payment_number": { "type": "string", "description": "The id of the payment associated with the expense " }, "amount_iso": { "type": "string", "description": "A certain amount from this expense is associated with the payment " }, "invoice": { "type": "string", "description": "Id of the invoice that includes a part of the expense " }, "invoice_number": { "type": "string", "description": "The number of the invoice that includes a part of the expense " } } }, "ExpensePaymentNew": { "type": "object", "properties": { "payment": { "type": "string", "enum": [ "info_msg" ], "description": "Select a payment for the expense ; info_msg - The maximum amount that can be deducted is __amount__. Unpaid amount of the expense is __expense_amount__", "example": "" }, "amount": { "type": "string", "description": "Amount that will be deducted from the expense ", "example": "1.00" } } }, "ExpensePayment": { "type": "object", "properties": { "amount": { "type": "string", "description": "Amount that will be deducted from the expense ", "example": "1.00" } } }, "PaymentExpenseElem": { "type": "object", "properties": { "expense": { "type": "string", "description": "Id of the expense associated with the payment " }, "expense_locale_name": { "type": "string", "description": "The name of the expense associated with the payment " }, "disable_change_expense": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "amount_iso": { "type": "string", "description": "A certain amount from this expense is associated with the payment " }, "invoice": { "type": "string", "description": "Id of the invoice that includes a part of the expense " }, "invoice_number": { "type": "string", "description": "The number of the invoice that includes a part of the expense " } } }, "PaymentExpenseNew": { "type": "object", "properties": { "expense": { "type": "string", "enum": [ "info_msg" ], "description": "; info_msg - Unpaid amount of the expense is __expense_amount__. The maximum that can be deducted the from the payment is __amount__, ", "example": "" }, "amount": { "type": "string", "description": "Amount that will be deducted from the expense ", "example": "1.00" } } }, "PaymentExpense": { "type": "object", "properties": { "amount": { "type": "string", "description": "Amount that will be deducted from the expense ", "example": "1.00" } } }, "ExpenseElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "locale_name": { "type": "string", "description": "Expense name" }, "account": { "type": "string", "description": "Client's account that was debited for the service " }, "realdate": { "type": "string", "description": "Date when funds were charged for the service provided" }, "cdate": { "type": "string", "description": "Service activation date" }, "amount": { "type": "string", "description": "Amount that was debited " }, "notpayd": { "type": "string", "description": "Not paid " }, "discountamount": { "type": "string", "description": "Discount that was given to the client when charging his account " }, "payments": { "type": "string", "description": "Number of payments associated with this expense" }, "discount": { "type": "string", "description": "Id of the client's discount " }, "taxamount": { "type": "string", "description": "Tax amount" } } }, "Expense": { "type": "object", "properties": { "amount": { "type": "string", "description": "Expense amount", "example": "1.00" }, "taxrate": { "type": "string", "description": "Tax rate. Note: tax amount is included into expense. Tax amount will be calculated as follows: AMOUNT - (AMOUNT / (100 + RATE) / 100) ", "example": "" }, "realdate": { "type": "string", "description": "Date when the client was charged for the service", "example": "text" }, "cdate": { "type": "string", "description": "Service activation date", "example": "text" }, "name": { "type": "string", "description": "Enter any name you want to use, otherwise the name will be generated automatically based on the operation selected above ", "example": "" } } }, "ProfileElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "wrongaddress": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Mail was returned \"" }, "need_phone": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Phone number is not verified \"" }, "need_activation": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Requires email confirmation \"" }, "need_manual_vetting": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Requires manual confirmation \"" }, "account": { "type": "string", "description": "Client associated with this payer " }, "profiletype": { "type": "string", "description": "Select a payer status" }, "status": { "type": "string" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" } } }, "ProfileAddNew": { "type": "object", "properties": { "country": { "type": "string", "enum": [ "legal", "physical", "legal", "physical" ], "description": "Select a country; legal - Country; physical - Country; legal - Country; physical - Country", "example": "" }, "profiletype": { "type": "string", "enum": [ "1", "2", "3", "1", "2", "3", "1", "2", "3", "1", "2", "3" ], "description": "Select a payer status; 1 - Individual; 2 - Company; 3 - Sole proprietor; 1 - Individual; 2 - Company; 3 - Sole proprietor; 1 - Individual; 2 - Company; 3 - Sole proprietor; 1 - Individual; 2 - Company; 3 - Sole proprietor", "example": "" }, "hidden_field": { "type": "string", "example": "" }, "request": { "type": "string", "example": "" }, "name": { "type": "string", "description": "Enter a company name", "example": "text" }, "person": { "type": "string", "description": "Enter the name of the contact person", "example": "text" }, "phone": { "type": "string", "description": "Enter the phone number", "example": "" }, "fax": { "type": "string", "description": "Enter the fax number", "example": "" }, "email": { "type": "string", "description": "Enter the company's email", "example": "example@domain.com" }, "maildocs": { "type": "string", "enum": [ "0", "1", "2", "3", "0", "1", "2", "3" ], "description": "Select how to obtain originals of financial documents; 0 - In Client area; 1 - By post; 2 - By email; 3 - Via the electronic document management system; 0 - In Client area; 1 - By post; 2 - By email; 3 - Via the electronic document management system", "example": "" }, "docflow_box": { "type": "string", "description": "Box for incoming documents (__company__)", "example": "" }, "docflow_department": { "type": "string", "description": "Select departments for incoming documents (__company__)", "example": "" }, "document_type": { "type": "string", "enum": [ "1", "2", "1", "2" ], "description": "Select a type of documents that will be sent via the electronic document flow ; 1 - Invoice ; 2 - Universal transfer document ; 1 - Invoice ; 2 - Universal transfer document ", "example": "" }, "id1c": { "type": "string", "description": "Enter the id to integrate with the accounting system", "example": "" }, "invoicetype": { "type": "string", "enum": [ "3", "0", "1", "2", "3", "0", "1", "2" ], "description": "Select how the system will generate reconciliation reports; 3 - Post-paid and paid expenses ; 0 - Based on expenses after payment; 1 - Automatically, based on advance payments; 2 - Based on payments due; 3 - Post-paid and paid expenses ; 0 - Based on expenses after payment; 1 - Automatically, based on advance payments; 2 - Based on payments due", "example": "" }, "postcompany": { "type": "string", "description": "Company that will be specified in the invoice ", "example": "" }, "postcurrency": { "type": "string", "description": "Invoice currency. If a client has unpaid expenses for which the invoice has been already generated, an advance payment can be made only by the company associated with that invoice and only in the invoice currency ", "example": "" }, "invoicedesc": { "type": "string", "description": "Enter any information related to the sevices.", "example": "" }, "payment_description": { "type": "string", "description": "Enter a purpose of advance payments", "example": "" }, "country_legal": { "type": "string", "description": "Select a contry where the company is registered", "example": "" }, "state_legal": { "type": "string", "description": "Region where the company is registered ", "example": "" }, "postcode_legal": { "type": "string", "description": "Enter the zip code of the company's registration address", "example": "" }, "city_legal": { "type": "string", "description": "Enter the city where the company is registered", "example": "" }, "legaleqphysical": { "type": "string", "enum": [ "on", "off" ], "description": "The option includes saving registred address in accordance with legal address ", "example": "off" }, "country_physical": { "type": "string", "description": "Select a country where the company is located ", "example": "" }, "state_physical": { "type": "string", "description": "Region where the company is located ", "example": "" }, "postcode_physical": { "type": "string", "description": "Enter the zip code of the city where this company is located ", "example": "" }, "city_physical": { "type": "string", "description": "Enter the city where the company is located ", "example": "" } } }, "Profile": { "type": "object", "properties": { "hidden_field": { "type": "string", "example": "" }, "request": { "type": "string", "example": "" }, "profiletype": { "type": "string", "enum": [ "1", "2", "3", "1", "2", "3" ], "description": "Select a payer status; 1 - Individual; 2 - Company; 3 - Sole proprietor; 1 - Individual; 2 - Company; 3 - Sole proprietor", "example": "" }, "name": { "type": "string", "description": "Enter a company name", "example": "text" }, "person": { "type": "string", "description": "Enter the name of the contact person", "example": "text" }, "phone": { "type": "string", "description": "Enter the phone number", "example": "" }, "fax": { "type": "string", "description": "Enter the fax number", "example": "" }, "email": { "type": "string", "description": "Enter the company's email", "example": "example@domain.com" }, "maildocs": { "type": "string", "enum": [ "0", "1", "2", "3", "0", "1", "2", "3" ], "description": "Select how to obtain originals of financial documents; 0 - In Client area; 1 - By post; 2 - By email; 3 - Via the electronic document management system; 0 - In Client area; 1 - By post; 2 - By email; 3 - Via the electronic document management system", "example": "" }, "docflow_box": { "type": "string", "description": "Box for incoming documents (__company__)", "example": "" }, "docflow_department": { "type": "string", "description": "Select departments for incoming documents (__company__)", "example": "" }, "document_type": { "type": "string", "enum": [ "1", "2", "1", "2" ], "description": "Select a type of documents that will be sent via the electronic document flow ; 1 - Invoice ; 2 - Universal transfer document ; 1 - Invoice ; 2 - Universal transfer document ", "example": "" }, "id1c": { "type": "string", "description": "Enter the id to integrate with the accounting system", "example": "" }, "invoicetype": { "type": "string", "enum": [ "3", "0", "1", "2" ], "description": "Select how the system will generate reconciliation reports; 3 - Post-paid and paid expenses ; 0 - Based on expenses after payment; 1 - Automatically, based on advance payments; 2 - Based on payments due", "example": "" }, "postcompany": { "type": "string", "description": "Company that will be specified in the invoice ", "example": "" }, "postcurrency": { "type": "string", "description": "Invoice currency. If a client has unpaid expenses for which the invoice has been already generated, an advance payment can be made only by the company associated with that invoice and only in the invoice currency ", "example": "" }, "invoicedesc": { "type": "string", "description": "Enter any information related to the sevices.", "example": "" }, "payment_description": { "type": "string", "description": "Enter a purpose of advance payments", "example": "" }, "country_legal": { "type": "string", "description": "Select a contry where the company is registered", "example": "" }, "state_legal": { "type": "string", "description": "Region where the company is registered ", "example": "" }, "postcode_legal": { "type": "string", "description": "Enter the zip code of the company's registration address", "example": "" }, "city_legal": { "type": "string", "description": "Enter the city where the company is registered", "example": "" }, "legaleqphysical": { "type": "string", "enum": [ "on", "off" ], "description": "The option includes saving registred address in accordance with legal address ", "example": "off" }, "country_physical": { "type": "string", "description": "Select a country where the company is located ", "example": "" }, "state_physical": { "type": "string", "description": "Region where the company is located ", "example": "" }, "postcode_physical": { "type": "string", "description": "Enter the zip code of the city where this company is located ", "example": "" }, "city_physical": { "type": "string", "description": "Enter the city where the company is located ", "example": "" } } }, "ProfileCompanyElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "status": { "type": "string", "description": "Indicates whether the payer is assigned to this company or not " }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" } } }, "ProfileReconciliation": { "type": "object", "properties": { "company": { "type": "string", "description": "Select a company to print the reconciliation report", "example": "" }, "currency": { "type": "string", "description": "Select currency for the reconciliation report", "example": "" }, "fromdate": { "type": "string", "description": "Select a start date of the billing period", "example": "text" }, "todate": { "type": "string", "description": "Select an end date of the billing period", "example": "text" }, "prepair_invoice": { "type": "string", "enum": [ "on", "off" ], "description": "Add information about \"Preliminary\" invoices ", "example": "off" } } }, "ProfileHistoryElem": { "type": "object", "properties": { "changedate": { "type": "string" }, "desc": { "type": "string" }, "user": { "type": "string" }, "ip": { "type": "string" }, "action": { "type": "string" } } }, "AccountOrdersItemtype": { "type": "object", "properties": {} }, "ContractElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "number": { "type": "string", "description": "Contract number" }, "signdate": { "type": "string", "description": "Date when the contract was signed" }, "senddate": { "type": "string", "description": "Date when the contract was sent" }, "end_date": { "type": "string", "description": "Select a contract expiration date " }, "client_name": { "type": "string", "description": "Name of the client's payer" }, "company_name": { "type": "string", "description": "Name of the provider's company" }, "contract_name": { "type": "string", "description": "Contract type" }, "contracttype": { "type": "string", "description": "Contract type " }, "status": { "type": "string", "description": "Current status of this contract" }, "non_standard": { "type": "string" }, "for_each_item": { "type": "string" } } }, "ContractNew": { "type": "object", "properties": { "companycontract": { "type": "string", "description": "Select a contract. You can add a new contract in \"Companies\" -- \"Contracts\"", "example": "" }, "profile": { "type": "string", "description": "Enter a payer Id to generate a contract", "example": "1" }, "show_non_standard_params": { "type": "string", "example": "" }, "end_date": { "type": "string", "description": "Select a contract expiration date ", "example": "" }, "file": { "type": "string", "description": "Attach contract", "example": "" } } }, "Contract": { "type": "object", "properties": { "number": { "type": "string", "description": "Contract number", "example": "" }, "signdate": { "type": "string", "description": "Date when the contract was signed", "example": "" }, "senddate": { "type": "string", "description": "Date when the contract was sent to client", "example": "" }, "companycontract": { "type": "string", "description": "Select a contract. You can add a new contract in \"Companies\" -- \"Contracts\"", "example": "" }, "status": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "0", "1", "2", "3", "4", "5", "0", "1", "2", "3", "4", "5", "120", "400", "300", "330", "110", "310", "350", "220", "101", "100", "340", "320", "120", "400", "300", "330", "110", "310", "350", "220", "101", "100", "340", "320" ], "description": "Select a contract status; 1 - Drafting ; 2 - Requested; 3 - Sent; 4 - Signed; 5 - Cancelled; 0 - Unknown; 1 - Draft; 2 - Requested; 3 - Sent; 4 - Signed; 5 - Cancelled; 0 - Unknown; 1 - Draft; 2 - Requested; 3 - Sent; 4 - Signed; 5 - Cancelled; 120 - Declined by client ; 400 - Document flow completed ; 300 - Waiting for cancellation ; 330 - Cancelled ; 110 - Signed by client ; 310 - Cancellation request from client ; 350 - Waiting for company signature ; 220 - Declined by company ; 101 - Sent ; 100 - Awaiting sending ; 340 - Cancellation denied ; 320 - Cancellation request from company ; 120 - Declined by client ; 400 - Document flow completed ; 300 - Waiting for cancellation ; 330 - Cancelled ; 110 - Signed by client ; 310 - Cancellation request from client ; 350 - Waiting for company signature ; 220 - Declined by company ; 101 - Sent ; 100 - Awaiting sending ; 340 - Cancellation denied ; 320 - Cancellation request from company ", "example": "" }, "show_non_standard_params": { "type": "string", "example": "" }, "end_date": { "type": "string", "description": "Select a contract expiration date ", "example": "" }, "file": { "type": "string", "description": "Attach contract", "example": "" } } }, "ContractItemElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Service " }, "status": { "type": "string", "description": "Status " }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" } } }, "AccountgroupElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "props": { "type": "string", "description": "Client group parameters " }, "ignoreitemmax": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Service limit is not checked \"" }, "allowdeleteitem": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Clients can delete services \"" }, "allowsuspenditem": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Clients can activate/disable services \"" }, "ignoreabuserate": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Fines are not applied \"" }, "has_tax": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Tax rates are set for the client group \"" } } }, "AccountgroupNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter the name for the group", "example": "text" }, "allowsuspenditem": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to allow users of this group to suspend and activate their services", "example": "off" }, "allowdeleteitem": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to allow users of this group to delete their services", "example": "off" }, "ignoreitemmax": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to allow group members to order any number of services regardless their tariff plan settings ", "example": "off" }, "ignoreabuserate": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to apply fines to members of this group ", "example": "off" } } }, "Accountgroup": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter the name for the group", "example": "text" }, "allowsuspenditem": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to allow users of this group to suspend and activate their services", "example": "off" }, "allowdeleteitem": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to allow users of this group to delete their services", "example": "off" }, "ignoreitemmax": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to allow group members to order any number of services regardless their tariff plan settings ", "example": "off" }, "ignoreabuserate": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to apply fines to members of this group ", "example": "off" } } }, "AccountgroupAccountElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Client" }, "status": { "type": "string", "description": "Client is assigned/not assigned to the group" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" } } }, "AccountgroupTaxruleElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "project": { "type": "string" }, "company": { "type": "string" }, "country": { "type": "string", "description": "Payer country" }, "taxrate": { "type": "string", "description": "Tax rate" }, "itemtype": { "type": "string", "description": "Product type " }, "startdatetime": { "type": "string", "description": "Start date of the tax rate " }, "enddatetime": { "type": "string", "description": "End date of the tax rate " } } }, "AccountgroupTaxruleNew": { "type": "object", "properties": { "project": { "type": "string", "example": "" }, "company": { "type": "string", "enum": [ "null", "null" ], "description": "; null - -- All --; null - -- All --", "example": "" }, "country": { "type": "string", "description": "Select a country. A newly created tax rule will be applied to payers from this country ", "example": "" }, "state": { "type": "string", "enum": [ "null", "null" ], "description": "If a two-layer tax system is used, you can add a federal (all) tax and state tax, which will be summed up ; null - -- All --; null - -- All --", "example": "" }, "taxrate": { "type": "string", "description": "Enter a tax rate for the selected country", "example": "text" }, "timezone": { "type": "string", "description": "Select a time zone", "example": "" }, "startdatetime": { "type": "string", "description": "Start date of the tax rate ", "example": "" }, "enddatetime": { "type": "string", "description": "End date of the tax rate ", "example": "" }, "specialitemtype": { "type": "string", "enum": [ "on", "off" ], "description": "Taxes are imposed only on particular product types ", "example": "off" }, "itemtype": { "type": "string", "description": "Select product types to impose a tax ", "example": "" } } }, "AccountgroupTaxrule": { "type": "object", "properties": { "project": { "type": "string", "example": "" }, "company": { "type": "string", "enum": [ "null", "null" ], "description": "; null - -- All --; null - -- All --", "example": "" }, "country": { "type": "string", "description": "Select a country. A newly created tax rule will be applied to payers from this country ", "example": "" }, "state": { "type": "string", "enum": [ "null", "null" ], "description": "If a two-layer tax system is used, you can add a federal (all) tax and state tax, which will be summed up ; null - -- All --; null - -- All --", "example": "" }, "taxrate": { "type": "string", "description": "Enter a tax rate for the selected country", "example": "text" }, "timezone": { "type": "string", "description": "Select a time zone", "example": "" }, "startdatetime": { "type": "string", "description": "Start date of the tax rate ", "example": "" }, "enddatetime": { "type": "string", "description": "End date of the tax rate ", "example": "" }, "specialitemtype": { "type": "string", "enum": [ "on", "off" ], "description": "Taxes are imposed only on particular product types ", "example": "off" }, "itemtype": { "type": "string", "description": "Select product types to impose a tax ", "example": "" } } }, "AccountgroupTaxruleSettings": { "type": "object", "properties": { "taxexclusive": { "type": "string", "enum": [ "on", "off" ], "description": "Select this check box to add a tax to product's price. Tax rates limited by company to which payments are made, cannot be used ", "example": "off" }, "taxcustompay": { "type": "string", "enum": [ "on", "off" ], "description": "Show the tax amount when a client adds funds to his account. This is an obligatory option only for specific countries. Learn tax regulations for your country ", "example": "off" } } }, "AccountgroupHistoryElem": { "type": "object", "properties": { "changedate": { "type": "string" }, "desc": { "type": "string" }, "user": { "type": "string" }, "ip": { "type": "string" }, "action": { "type": "string" } } }, "AccountgroupConditionElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "condition": { "type": "string", "description": "Describe a condition " }, "conditiongroup": { "type": "string", "description": "Conditions to assign a client to clients group. It will be applied, if at least one condition is met. A client will be added into group, if all conditions are met and conditions without group " } } }, "PaymentElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "number": { "type": "string", "description": "Payment number according to the company's numbering system, or payment method " }, "create_date": { "type": "string", "description": "Date when the payment was placed " }, "pay_date": { "type": "string", "description": "Date when funds were credited to client's account" }, "sender_name": { "type": "string", "description": "Payer who made this payment " }, "recipient_name": { "type": "string", "description": "Payee. It is not present, if the payment method is not associated with any company " }, "project": { "type": "string", "description": "Provider associated with this payment" }, "account_name": { "type": "string", "description": "Client who made the payment " }, "paymethod_name": { "type": "string", "description": "Payment method associated with this payment " }, "subaccountamount_iso": { "type": "string", "description": "Amount credited to the client's account " }, "autogenerated": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Payments amount is calculated automatically \"" }, "paymethodamount_iso": { "type": "string", "description": "Payment amount in currency of the selected payment method" }, "billorder": { "type": "string", "description": "The order associated with the payment " }, "status": { "type": "string", "description": "Payment status " }, "store_payment": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"After the payment is credited successfully, the payment method will be saved\"" } } }, "Payment": { "type": "object", "properties": { "number": { "type": "string", "description": "Invoice number ", "example": "text" }, "createdate": { "type": "string", "description": "Date and time when the invoice was generated", "example": "text" }, "paydate": { "type": "string", "description": "Date when the payment was made or funds were added to the client's account", "example": "" }, "documentnumber": { "type": "string", "description": "Number of the payment document", "example": "" }, "documentdate": { "type": "string", "description": "Date when the payment document was generated", "example": "" }, "description": { "type": "string", "description": " Enter a purpose of payment", "example": "" }, "sender": { "type": "string", "description": "Payer who made the payment", "example": "" }, "recipient": { "type": "string", "enum": [ "tax_info" ], "description": "The company that will receive the payment. The list includes the companies connected to the payment method and available to the selected payer ; tax_info - If the recipient company changes, a new tax will be billed according to the tax rate of the new recipient company", "example": "" }, "show_recipient_tax_info": { "type": "string", "example": "" }, "subaccountamount": { "type": "string", "description": "Payment amount added to client's account ", "example": "1.00" }, "usedamount": { "type": "string", "description": "The amount that was debited ", "example": "1.00" }, "paymethodamount": { "type": "string", "description": "Amount in the payment system's currency", "example": "1.00" }, "commissionamount": { "type": "string", "description": "Commission charged from the client's account while making a payment", "example": "1.00" }, "taxamount_readonly": { "type": "string", "description": "Tax amount", "example": "1.00" }, "show_taxamount": { "type": "string", "example": "" }, "status": { "type": "string", "enum": [ "1_fully_paid", "1_part_postpaid", "1_postpaid", "9", "1", "100", "2", "3", "4", "5", "6", "7", "8", "1_fully_paid", "1_part_postpaid", "1_postpaid", "9", "1", "100", "2", "3", "4", "5", "6", "7", "8" ], "description": "Payment status; 1_fully_paid - Paid in full; 1_part_postpaid - Partly paid; 1_postpaid - For payment ; 9 - Canceled ; 1 - New; 100 - Deletion in progress; 2 - Payment in progress; 3 - Reserved payment ; 4 - Paid; 5 - Awaiting refund; 6 - Refunded; 7 - Suspect; 8 - Initiated; 1_fully_paid - Paid in full; 1_part_postpaid - Partly paid; 1_postpaid - For payment ; 9 - Canceled ; 1 - New; 100 - Deletion in progress; 2 - Payment in progress; 3 - Reserved payment ; 4 - Paid; 5 - Awaiting refund; 6 - Refunded; 7 - Suspect; 8 - Initiated", "example": "" }, "paymethod": { "type": "string", "description": "Payment method", "example": "" }, "restrictrefund": { "type": "string", "enum": [ "on", "off" ], "description": "Refund of this payment is prohibited ", "example": "off" } } }, "PaymentRefund": { "type": "object", "properties": { "amount": { "type": "string", "description": "Refund amount in payment's currency ", "example": "" }, "description": { "type": "string", "description": "Reason for refund. This information will be sent to the payment gateway ", "example": "text" } } }, "PaymentOrderinfoElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "info": { "type": "string", "description": "Unit name" }, "cost": { "type": "string", "description": "Unit price " } } }, "PaymentOrderinfo": { "type": "object", "properties": { "name": { "type": "string", "description": "Invoice item description", "example": "" } } }, "PaymentHistoryElem": { "type": "object", "properties": { "changedate": { "type": "string", "description": "Change date " }, "desc": { "type": "string", "description": "Change description " }, "user": { "type": "string", "description": "User who made changes" }, "ip": { "type": "string", "description": "User IP address or internal utility, which made the changes " }, "action": { "type": "string", "description": "Internal name of the function associated with the changes " } } }, "PricelistElem": { "type": "object", "properties": { "processingmodules": { "type": "string", "description": "Processing modules associated with this tariff plan" }, "pricelist_cost": { "type": "string", "description": "Basic price of a tariff plan" }, "orderpriority": { "type": "string", "description": "Set priority for this tariff plan (count forward)" }, "status": { "type": "string", "description": "Enter additional information related to the tariff plan " }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" }, "orderreference": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"This tariff plan will be available for order, only if other tariff services are activated in the \"Access\" module \"" }, "billdaily": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Daily charges\"" }, "sync_in_progress": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Synchronization with the control panel\"" }, "quickorder": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Tariff is available for quick order \"" }, "filter_group_value": { "type": "string", "description": "Values of connected filters" }, "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "itemtype_name": { "type": "string", "description": "Service type associated with this tariff plan" }, "project": { "type": "string", "description": "Provider of the tariff plan " } } }, "PricelistArchivedElem": { "type": "object", "properties": { "processingmodules": { "type": "string", "description": "Processing modules associated with this tariff plan" }, "pricelist_cost": { "type": "string", "description": "Basic price of a tariff plan" }, "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "itemtype_name": { "type": "string", "description": "Service type associated with this tariff plan" }, "project": { "type": "string", "description": "Provider of the tariff plan " } } }, "PricelistExtractArchive": { "type": "object", "properties": { "active": { "type": "string", "enum": [ "on", "off" ], "description": "Activate tariffs after extraction", "example": "off" } } }, "PricelistAddNew": { "type": "object", "properties": { "project": { "type": "string", "description": "Provider of this tariff plan ", "example": "" }, "activate": { "type": "string", "enum": [ "on", "off" ], "description": "A newly created tariff plan will be activated after creation. If you want to modify it or its add-ons later, we recommend that you disable the option and activate the tariff after setup", "example": "off" }, "name": { "type": "string", "description": "Enter the tariff plan name", "example": "text" }, "processingmodule": { "type": "string", "description": "Select processing modules for the newly created tariff plan. Tariff plans won't be available for order, if they are not associated with a processing module ", "example": "" }, "modulepreset": { "type": "string", "description": "Configuration", "example": "" }, "intname": { "type": "string", "description": "Enter an internal name that will be used for getting default parameters of newly created services from the processing module, or for identifying basic configuration in case of manual setup ", "example": "text" }, "datacenter": { "type": "string", "description": "The tariff will be available for the specified data centers ", "example": "" }, "change_datacenter": { "type": "string", "example": "" }, "billdaily": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to charge clients on a daily basis. The amount will be calculated in proportin to daily price in the selected month. The tariff upgrade policy cannot be applied", "example": "off" }, "alignexpenseamount": { "type": "string", "enum": [ "on", "off" ], "description": "Enable this option to calculate the daily cost depending on the number of days in an order period rather than for every individual month ", "example": "off" }, "billhourly": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to allow clients to start/suspend services associated with this tariff plan. If the \"Charge client after suspension\" check box is selected, the client will be compensated for his service downtime. Funds are charged at the beginning of the day, and the client will be compensated the next day taking into account his service downtime ", "example": "off" }, "chargestoped": { "type": "string", "enum": [ "on", "off" ], "description": "If you clear the check box, the client will be compensated for his service downtime. This option is available for every service (it is enabled by default). Options in tariff configuration form and in additional resources are not interrelated", "example": "off" }, "autocalcday": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to calculate the month price divided by the number of days in the month ", "example": "off" }, "billprorata": { "type": "string", "enum": [ "on", "off" ], "description": "Selecting this check box will change the service validity period by a calendar month depending on a date selected in the \"Pro-rata day\" field. If a client orders the service before the specified date, its expiration date will be set before the end of the current month. If he makes an order at the specified date or later - until the end of the next month. Order/renewal price will be changed in proportion to changes of the service validity period ", "example": "off" }, "prorataday": { "type": "string", "description": "Select a day for calendar-based charges ", "example": "1" }, "quickorder": { "type": "string", "enum": [ "on", "off" ], "description": "Enable quick order of services, a client won't need to enter any parameters during order ", "example": "off" }, "opennotify": { "type": "string", "description": "Service activation notification template", "example": "" }, "license": { "type": "string", "enum": [ "count", "count_to", "count_from", "count", "count_to", "count_from" ], "description": "Select a Service agreement template that clients will need to accept while ordering a service. You can add or edit a template in the \"Document templates\" module ; count - Number of licenses; count_to - Number of licenses <= ; count_from - Number of licenses >= ; count - Number of licenses; count_to - Number of licenses <= ; count_from - Number of licenses >= ", "example": "" }, "pricelist_group": { "type": "string", "description": "Select a tariff group in order to give global discounts, set trial policies, and group tariff plans in reports ", "example": "" }, "create_addon": { "type": "string", "enum": [ "on", "off" ], "description": "All add-ons available for this tariff plan will be created while creating a tariff plan ", "example": "off" }, "ostemplate": { "type": "string", "description": "OS templates that will be included into the tariff plan ", "example": "" }, "accessgroups": { "type": "string", "description": "Select the groups of clients that will be able to order and upgrade to this tariff plan ", "example": "" }, "denygroups": { "type": "string", "description": "Select the groups of clients that won't be able to order and upgrade to this tariff plan", "example": "" }, "minperiodtype": { "type": "string", "enum": [ "0", "1", "2", "0", "1", "2" ], "description": "Select an order period. When this period is over, a client can cancel his service. In case of daily charges, this value may affect the amount of funds reserved for a service ; 0 - Unlimited; 1 - Month; 2 - Day; 0 - Unlimited; 1 - Month; 2 - Day", "example": "" }, "minperiodlen": { "type": "string", "description": "Enter the minimum period in days or months ", "example": "1" }, "trial": { "type": "string", "description": "Enter a trial period in days. You can set trial policy in a product type edit form. Leave the field blank if this tariff plan doesn't have a trial period", "example": "1" }, "trial_itemmax": { "type": "string", "description": "The maximum number of trials available for this tariff plan", "example": "0" }, "itemmax": { "type": "string", "description": "Enter the maximum number of services that a client can order. The client won't be able to order add-ons for this tariff plan once reaching this limit", "example": "0" }, "allow_multiple_order": { "type": "string", "enum": [ "on", "off" ], "description": "Ability to add several services at the same time to the cart ", "example": "off" }, "max_multiple_order_count": { "type": "string", "description": "A large maximum number of simultaneously ordered services can affect the billing operation", "example": "2" }, "suspendpenaltytype": { "type": "string", "enum": [ "0", "1", "2", "3", "0", "1", "2", "3" ], "description": "A client will be charged this late renewal fee while renewing a service ; 0 - Without fee; 1 - Fixed amount; 2 - Percent from the price for late renewal ; 3 - Renew from suspension date; 0 - Without fee; 1 - Fixed amount; 2 - Percent from the price for late renewal ; 3 - Renew from suspension date", "example": "" }, "suspendpenaltypercent": { "type": "string", "description": "Enter the price percent for overdue services", "example": "text" }, "allownosuitable": { "type": "string", "enum": [ "on", "off" ], "description": "The service will be available for order even if there are no resources or dedicated servers available", "example": "off" }, "suspendperiod": { "type": "string", "description": "Set a period in days that will pass before a suspended service will be deleted. Leave the field blank to apply the product type settings", "example": "1" }, "nostopholidays": { "type": "string", "enum": [ "nostop", "stop", "nostop", "stop" ], "description": "Select a service cancellation policy ; nostop - Do not suspend services; stop - Suspend services; nostop - Do not suspend services; stop - Suspend services", "example": "" }, "changepolicy": { "type": "string", "enum": [ "4", "0", "1", "2", "3", "4", "0", "1", "2", "3" ], "description": "Tariff plan change policy ; 4 - Full payment for a new tariff plan ; 0 - Change period; 1 - Add funds/refund; 2 - Tariff cannot be changed; 3 - Extra charge only, no refund upon downgrade; 4 - Full payment for a new tariff plan ; 0 - Change period; 1 - Add funds/refund; 2 - Tariff cannot be changed; 3 - Extra charge only, no refund upon downgrade", "example": "" }, "changeprolongpolicy": { "type": "string", "enum": [ "1", "0", "1", "0" ], "description": "Tariff upgrade policy ; 1 - service expiration date ; 0 - current date ; 1 - service expiration date ; 0 - current date ", "example": "" }, "orderpolicy": { "type": "string", "enum": [ "0", "1", "0", "1" ], "description": "Select how you want to calculate add-on prices; 0 - Price before a service expiration date; 1 - Full price over the whole period ; 0 - Price before a service expiration date; 1 - Full price over the whole period ", "example": "" }, "returnpolicy": { "type": "string", "enum": [ "2", "0", "1", "2", "0", "1" ], "description": "Select how you want to calculate refunds if a client cancels add-ons ; 2 - Change during renewal; 0 - Refund; 1 - No refund; 2 - Change during renewal; 0 - Refund; 1 - No refund", "example": "" }, "orderpriority": { "type": "string", "description": "Set priority for this tariff plan (count forward)", "example": "1" }, "order_img_upload": { "type": "string", "description": "Upload icon", "example": "" }, "show_addon_image": { "type": "string", "enum": [ "off", "on", "off", "on" ], "description": "This option enables to configure and display resources' icons during service order and modification; off - Do not show icons; on - Show icons; off - Do not show icons; on - Show icons", "example": "" } } }, "PricelistClone": { "type": "object", "properties": { "project": { "type": "string", "description": "Select a provider to clone the tariff plan", "example": "" }, "priceconverttype": { "type": "string", "description": "Select a recalculation method for this tariff plan", "example": "" }, "name": { "type": "string", "description": "Enter the tariff plan name", "example": "text" }, "intname": { "type": "string", "description": "This internal name must match the name of the tariff plan on the server where the service will be set up", "example": "text" }, "processingmodule": { "type": "string", "description": "Select processing modules for the newly created tariff plan. Tariff plans won't be available for order, if they are not associated with a processing module ", "example": "" }, "modulepreset": { "type": "string", "description": "Configuration", "example": "" }, "activate": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to make this tariff plan available for ordering", "example": "off" }, "orderpriority": { "type": "string", "description": "Set priority for this tariff plan (count forward)", "example": "1" } } }, "PricelistImport": { "type": "object", "properties": { "module": { "type": "string", "description": "Select a processing module", "example": "" }, "itemtype": { "type": "string", "description": "Select a product type", "example": "" }, "pricelist": { "type": "string", "description": "Select a tariff plan", "example": "" }, "project": { "type": "string", "description": "Select a provider this tariff plan will be imported to ", "example": "" } } }, "Pricelist": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter the tariff plan name", "example": "text" }, "processingmodule": { "type": "string", "description": "Select processing modules for the newly created tariff plan. Tariff plans won't be available for order, if they are not associated with a processing module ", "example": "" }, "modulepreset": { "type": "string", "description": "Configuration", "example": "" }, "intname": { "type": "string", "description": "Enter an internal name that will be used for getting default parameters of newly created services from the processing module, or for identifying basic configuration in case of manual setup ", "example": "text" }, "datacenter": { "type": "string", "description": "The tariff will be available for the specified data centers ", "example": "" }, "change_datacenter": { "type": "string", "example": "" }, "billdaily": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to charge clients on a daily basis. The amount will be calculated in proportin to daily price in the selected month. The tariff upgrade policy cannot be applied", "example": "off" }, "alignexpenseamount": { "type": "string", "enum": [ "on", "off" ], "description": "Enable this option to calculate the daily cost depending on the number of days in an order period rather than for every individual month ", "example": "off" }, "billhourly": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to allow clients to start/suspend services associated with this tariff plan. If the \"Charge client after suspension\" check box is selected, the client will be compensated for his service downtime. Funds are charged at the beginning of the day, and the client will be compensated the next day taking into account his service downtime ", "example": "off" }, "chargestoped": { "type": "string", "enum": [ "on", "off" ], "description": "If you clear the check box, the client will be compensated for his service downtime. This option is available for every service (it is enabled by default). Options in tariff configuration form and in additional resources are not interrelated", "example": "off" }, "autocalcday": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to calculate the month price divided by the number of days in the month ", "example": "off" }, "billprorata": { "type": "string", "enum": [ "on", "off" ], "description": "Selecting this check box will change the service validity period by a calendar month depending on a date selected in the \"Pro-rata day\" field. If a client orders the service before the specified date, its expiration date will be set before the end of the current month. If he makes an order at the specified date or later - until the end of the next month. Order/renewal price will be changed in proportion to changes of the service validity period ", "example": "off" }, "prorataday": { "type": "string", "description": "Select a day for calendar-based charges ", "example": "1" }, "quickorder": { "type": "string", "enum": [ "on", "off" ], "description": "Enable quick order of services, a client won't need to enter any parameters during order ", "example": "off" }, "opennotify": { "type": "string", "description": "Service activation notification template. It will be sent to a client's email upon service activation. You can also find the instruction in the service module by clicking the corresponding button on the toolbar. ", "example": "" }, "license": { "type": "string", "enum": [ "count", "count_to", "count_from", "count", "count_to", "count_from" ], "description": "Select a Service agreement template that clients will need to accept while ordering a service. You can add or edit a template in the \"Document templates\" module ; count - Number of licenses; count_to - Number of licenses <= ; count_from - Number of licenses >= ; count - Number of licenses; count_to - Number of licenses <= ; count_from - Number of licenses >= ", "example": "" }, "pricelist_group": { "type": "string", "description": "Select a tariff group in order to give global discounts, set trial policies, and group tariff plans in reports ", "example": "" }, "ostemplate": { "type": "string", "description": "OS templates that will be included into the tariff plan ", "example": "" }, "accessgroups": { "type": "string", "description": "Select the groups of clients that will be able to order and upgrade to this tariff plan ", "example": "" }, "denygroups": { "type": "string", "description": "Select the groups of clients that won't be able to order and upgrade to this tariff plan", "example": "" }, "minperiodtype": { "type": "string", "enum": [ "0", "1", "2" ], "description": "Select an order period. When this period is over, a client can cancel his service. In case of daily charges, this value may affect the amount of funds reserved for a service ; 0 - Unlimited; 1 - Month; 2 - Day", "example": "" }, "minperiodlen": { "type": "string", "description": "Enter the minimum period in days or months ", "example": "1" }, "trial": { "type": "string", "description": "Enter a trial period in days. You can set trial policy in a product type edit form. Leave the field blank if this tariff plan doesn't have a trial period", "example": "1" }, "trial_itemmax": { "type": "string", "description": "The maximum number of trials available for this tariff plan", "example": "0" }, "itemmax": { "type": "string", "description": "Enter the maximum number of services that a client can order. The client won't be able to order add-ons for this tariff plan once reaching this limit", "example": "0" }, "allow_multiple_order": { "type": "string", "enum": [ "on", "off" ], "description": "Ability to add several services at the same time to the cart ", "example": "off" }, "max_multiple_order_count": { "type": "string", "description": "A large maximum number of simultaneously ordered services can affect the billing operation", "example": "2" }, "suspendpenaltytype": { "type": "string", "enum": [ "0", "1", "2", "3" ], "description": "A client will be charged this late renewal fee while renewing a service ; 0 - Without fee; 1 - Fixed amount; 2 - Percent from the price for late renewal ; 3 - Renew from suspension date", "example": "" }, "suspendpenaltypercent": { "type": "string", "description": "Enter the price percent for overdue services", "example": "text" }, "allownosuitable": { "type": "string", "enum": [ "on", "off" ], "description": "The service will be available for order even if there are no resources or dedicated servers available", "example": "off" }, "suspendperiod": { "type": "string", "description": "Set a period in days that will pass before a suspended service will be deleted. Leave the field blank to apply the product type settings", "example": "1" }, "nostopholidays": { "type": "string", "enum": [ "nostop", "stop" ], "description": "Select a service cancellation policy ; nostop - Do not suspend services; stop - Suspend services", "example": "" }, "changepolicy": { "type": "string", "enum": [ "4", "0", "1", "2", "3" ], "description": "Tariff plan change policy ; 4 - Full payment for a new tariff plan ; 0 - Change period; 1 - Add funds/refund; 2 - Tariff cannot be changed; 3 - Extra charge only, no refund upon downgrade", "example": "" }, "changeprolongpolicy": { "type": "string", "enum": [ "1", "0" ], "description": "Tariff upgrade policy ; 1 - service expiration date ; 0 - current date ", "example": "" }, "orderpolicy": { "type": "string", "enum": [ "0", "1" ], "description": "Select how you want to calculate add-on prices; 0 - Price before a service expiration date; 1 - Full price over the whole period ", "example": "" }, "returnpolicy": { "type": "string", "enum": [ "2", "0", "1" ], "description": "Select how you want to calculate refunds if a client cancels add-ons ; 2 - Change during renewal; 0 - Refund; 1 - No refund", "example": "" }, "endoflifedate": { "type": "string", "description": "The end date of the tariff plan after service renewal ", "example": "" }, "orderpriority": { "type": "string", "description": "Set priority for this tariff plan (count forward)", "example": "1" }, "order_img_upload": { "type": "string", "description": "Upload icon", "example": "" }, "show_addon_image": { "type": "string", "enum": [ "off", "on" ], "description": "This option enables to configure and display resources' icons during service order and modification; off - Do not show icons; on - Show icons", "example": "" } } }, "PricelistProcessingElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Processing module name " }, "orderpriority": { "type": "string", "description": "Priority of the service processing module " }, "status": { "type": "string", "description": "Processing module associated with the tariff plan " }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" } } }, "PricelistDetailElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "price": { "type": "string", "description": "Add-on unit price " }, "orderpriority": { "type": "string", "description": "Set priority for the selected tariff add-on (count forward)" }, "status": { "type": "string", "description": "Add-on current status" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" }, "is_compound": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Billing type - client can choose \"" }, "manualprocessing": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Manual setup is active \"" }, "restrictclientchange": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Client cannot make changes after order \"" }, "has_scale": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Price range of possible addon values is created \"" } } }, "PricelistDetailNew": { "type": "object", "properties": { "billtype": { "type": "string", "enum": [ "5", "1", "2", "3", "4" ], "description": "Choose how you want to charge customers for this add-on; 5 - Based on values of other resources ; 1 - Do not bill; 2 - Based on order; 3 - Based on statistics; 4 - Client can choose", "example": "" }, "chargestoped": { "type": "string", "enum": [ "on", "off" ], "description": "If you clear this check box, the client will be compensated for his service downtime ", "example": "off" }, "itemtype": { "type": "string", "enum": [ "settings", "settings", "settings", "settings", "settings", "settings" ], "description": "Select an add-on type ; settings - Additional settings; settings - Additional settings; settings - Additional settings; settings - Additional settings; settings - Additional settings; settings - Additional settings", "example": "" }, "addontype": { "type": "string", "enum": [ "1", "2", "3", "4", "manual", "compound", "2", "3", "1", "manual", "compound", "2", "3", "1", "manual", "compound", "2", "3", "1", "manual", "compound", "2", "3", "1", "manual", "compound", "2", "3", "1", "manual", "compound", "2", "3", "1" ], "description": "Select how you want to provide add-ons for this tariff plan ; 1 - Boolean (Yes/No); 2 - Integer; 3 - Enumeration; 4 - Enumeration with quantity; manual - Addition value. Available only to Administrator; compound - Add-on charging method ; 2 - Add-on value including the tariff limit::<br/> - included into the tariff: <b>__limit__ __measure__</b>__intvalue_msg__ __intvalue_new_msg__ __intvalue_used_msg__ __min_msg__<br/> - maximum: <b>__max__ __measure__</b>; 3 - Select a value for the service add-on<br/>(tariff includes: <b>__enumitem__</b>); 1 - Select the check box if you want to use add-ons for this service<br/>(tariff includes: <b>__addonbool_value__</b>); manual - Addition value. Available only to Administrator; compound - Add-on charging method ; 2 - Add-on value including the tariff limit::<br/> - included into the tariff: <b>__limit__ __measure__</b>__intvalue_msg__ __intvalue_new_msg__ __intvalue_used_msg__ __min_msg__<br/> - maximum: <b>__max__ __measure__</b>; 3 - Select a value for the service add-on<br/>(tariff includes: <b>__enumitem__</b>); 1 - Select the check box if you want to use add-ons for this service<br/>(tariff includes: <b>__addonbool_value__</b>); manual - Addition value. Available only to Administrator; compound - Add-on charging method ; 2 - Add-on value including the tariff limit::<br/> - included into the tariff: <b>__limit__ __measure__</b>__intvalue_msg__ __intvalue_new_msg__ __intvalue_used_msg__ __min_msg__<br/> - maximum: <b>__max__ __measure__</b>; 3 - Select a value for the service add-on<br/>(tariff includes: <b>__enumitem__</b>); 1 - Select the check box if you want to use add-ons for this service<br/>(tariff includes: <b>__addonbool_value__</b>); manual - Addition value. Available only to Administrator; compound - Add-on charging method ; 2 - Add-on value including the tariff limit::<br/> - included into the tariff: <b>__limit__ __measure__</b>__intvalue_msg__ __intvalue_new_msg__ __intvalue_used_msg__ __min_msg__<br/> - maximum: <b>__max__ __measure__</b>; 3 - Select a value for the service add-on<br/>(tariff includes: <b>__enumitem__</b>); 1 - Select the check box if you want to use add-ons for this service<br/>(tariff includes: <b>__addonbool_value__</b>); manual - Addition value. Available only to Administrator; compound - Add-on charging method ; 2 - Add-on value including the tariff limit::<br/> - included into the tariff: <b>__limit__ __measure__</b>__intvalue_msg__ __intvalue_new_msg__ __intvalue_used_msg__ __min_msg__<br/> - maximum: <b>__max__ __measure__</b>; 3 - Select a value for the service add-on<br/>(tariff includes: <b>__enumitem__</b>); 1 - Select the check box if you want to use add-ons for this service<br/>(tariff includes: <b>__addonbool_value__</b>); manual - Addition value. Available only to Administrator; compound - Add-on charging method ; 2 - Add-on value including the tariff limit::<br/> - included into the tariff: <b>__limit__ __measure__</b>__intvalue_msg__ __intvalue_new_msg__ __intvalue_used_msg__ __min_msg__<br/> - maximum: <b>__max__ __measure__</b>; 3 - Select a value for the service add-on<br/>(tariff includes: <b>__enumitem__</b>); 1 - Select the check box if you want to use add-ons for this service<br/>(tariff includes: <b>__addonbool_value__</b>)", "example": "" }, "scaletype": { "type": "string", "enum": [ "3", "2", "1", "0" ], "description": "This parameter is used to calculate add-on price ; 3 - Possible values ; 2 - Value packages ; 1 - Per each scale step; 0 - By the nearest value ", "example": "" }, "restrictclientchange": { "type": "string", "enum": [ "downonly", "off", "on", "uponly" ], "description": "Resources modification policy ; downonly - Only downgrade ; off - Can be modified ; on - Cannot be modified ; uponly - Only upgrade ", "example": "" }, "minperiodtype": { "type": "string", "enum": [ "0", "1", "2", "0", "1", "2", "0", "1", "2", "0", "1", "2", "0", "1", "2", "0", "1", "2", "0", "1", "2" ], "description": "Select a minimum period that will pass before a client will be able to downgrade his add-on ; 0 - Unlimited; 1 - Month; 2 - Day; 0 - Unlimited; 1 - Month; 2 - Day; 0 - Unlimited; 1 - Month; 2 - Day; 0 - Unlimited; 1 - Month; 2 - Day; 0 - Unlimited; 1 - Month; 2 - Day; 0 - Unlimited; 1 - Month; 2 - Day; 0 - Unlimited; 1 - Month; 2 - Day", "example": "" }, "minperiodlen": { "type": "string", "description": "Enter the minimum order period for this add-on", "example": "1" }, "manualprocessing": { "type": "string", "enum": [ "on", "off" ], "description": "The service will be set up manually. The corresponding task will be created for a technical support team ", "example": "off" }, "manualprocessing_skipdefault": { "type": "string", "enum": [ "on", "off" ], "description": "With this option enabled and the default value selected, this add-on will not be added to manual processing.", "example": "off" }, "manualname": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to use the value specified below for a new add-on", "example": "off" }, "name": { "type": "string", "description": "Enter the tariff plan name", "example": "text" }, "intname": { "type": "string", "description": "Enter the internal name, only if the it differs from the internal name of the add-on type, or if several parameters should be calculated", "example": "" }, "processing_feature": { "type": "string", "description": "If you choose an addon with this feature, the handler will be selected that has this feature", "example": "" }, "roundtype": { "type": "string", "enum": [ "2", "0", "1" ], "description": "Select a rounding procedure ; 2 - Rounding downward; 0 - Mathematically ; 1 - Rounding upward ", "example": "" }, "addonstattype": { "type": "string", "enum": [ "1", "2", "period_2", "period_1", "period_2", "period_1", "period_2", "period_1", "period_2", "period_1", "period_2", "period_1", "period_2", "period_1" ], "description": "Select a period to bill a client for resource overuse; 1 - Per calendar month; 2 - Per day; period_2 - day; period_1 - month; period_2 - day; period_1 - month; period_2 - day; period_1 - month; period_2 - day; period_1 - month; period_2 - day; period_1 - month; period_2 - day; period_1 - month", "example": "" }, "addonstatcomparison": { "type": "string", "enum": [ "1", "2" ], "description": "Select how you want to bill a client if there are several parameters of the same type. For example, traffic can be incoming and outgoing; 1 - Sum; 2 - Maximum value", "example": "" }, "addonstatcalculation": { "type": "string", "enum": [ "0", "1" ], "description": "The price is specified for... If it is specified per item per month, the statistics will be calculated as follows: (overuse per day) * (price) / (number of days in a month); 0 - Item; 1 - item per month", "example": "" }, "addonstatchargestoped": { "type": "string", "enum": [ "on", "off" ], "description": "If this option is enabled, service will be charged even if it is suspended", "example": "off" }, "allowpostpaid": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to charge a client for resource overage without debiting his personal account ", "example": "off" }, "summarizeinvoice": { "type": "string", "enum": [ "on", "off" ], "description": "Sum up the values for the whole period ", "example": "off" }, "measure": { "type": "string", "description": "Select a unit of measure for this add-on. The value will be converted into a unit of measure used by the control panel ", "example": "" }, "addonlimit": { "type": "string", "description": "Default value for add-on ", "example": "0" }, "addonstep": { "type": "string", "description": "Add-on order step ", "example": "1" }, "addonmin": { "type": "string", "description": "Minimum order value. This value cannot be smaller than the value included into the tariff plan ", "example": "0" }, "addonmax": { "type": "string", "description": "Enter the maximum order value ", "example": "0" }, "addonlimittrial": { "type": "string", "description": "The default value for the add-on on a trial period", "example": "0" }, "addonmaxtrial": { "type": "string", "description": "Maximum value that can be ordered on a trial period ", "example": "0" }, "enumeration": { "type": "string", "description": "Values for add-on will be taken from this enumeration ", "example": "" }, "enumerationitem": { "type": "string", "description": "Enumeration element that this service includes by default", "example": "" }, "orderpolicy": { "type": "string", "enum": [ "0", "1", "0", "1", "0", "1", "0", "1", "0", "1", "0", "1", "0", "1" ], "description": "Here you can add rules how to calculate the price if you change service add-on ; 0 - difference in prices; 1 - full price; 0 - Price before a service expiration date; 1 - Full price over the whole period ; 0 - Price before a service expiration date; 1 - Full price over the whole period ; 0 - Price before a service expiration date; 1 - Full price over the whole period ; 0 - Price before a service expiration date; 1 - Full price over the whole period ; 0 - Price before a service expiration date; 1 - Full price over the whole period ; 0 - Price before a service expiration date; 1 - Full price over the whole period ", "example": "" }, "addonbool": { "type": "string", "enum": [ "on", "off" ], "description": "Default value for add-on ", "example": "off" }, "orderpriority": { "type": "string", "description": "Set priority for this add-on", "example": "1" }, "hideinorder": { "type": "string", "enum": [ "on", "off" ], "description": "When this option is enabled, the resource will not be displayed in the order lists", "example": "off" }, "order_img_upload": { "type": "string", "description": "Upload icon", "example": "" } } }, "PricelistDetail": { "type": "object", "properties": { "billtype": { "type": "string", "enum": [ "5", "1", "2", "3", "4" ], "description": "Choose how you want to charge customers for this add-on; 5 - Based on values of other resources ; 1 - Do not bill; 2 - Based on order; 3 - Based on statistics; 4 - Client can choose", "example": "" }, "chargestoped": { "type": "string", "enum": [ "on", "off" ], "description": "If you clear this check box, the client will be compensated for his service downtime ", "example": "off" }, "itemtype": { "type": "string", "enum": [ "settings", "settings", "settings", "settings", "settings", "settings" ], "description": "Select an add-on type ; settings - Additional settings; settings - Additional settings; settings - Additional settings; settings - Additional settings; settings - Additional settings; settings - Additional settings", "example": "" }, "addontype": { "type": "string", "enum": [ "1", "2", "3", "4", "manual", "compound", "2", "3", "1", "manual", "compound", "2", "3", "1", "manual", "compound", "2", "3", "1", "manual", "compound", "2", "3", "1", "manual", "compound", "2", "3", "1", "manual", "compound", "2", "3", "1" ], "description": "Select how you want to provide add-ons for this tariff plan ; 1 - Boolean (Yes/No); 2 - Integer; 3 - Enumeration; 4 - Enumeration with quantity; manual - Addition value. Available only to Administrator; compound - Add-on charging method ; 2 - Add-on value including the tariff limit::<br/> - included into the tariff: <b>__limit__ __measure__</b>__intvalue_msg__ __intvalue_new_msg__ __intvalue_used_msg__ __min_msg__<br/> - maximum: <b>__max__ __measure__</b>; 3 - Select a value for the service add-on<br/>(tariff includes: <b>__enumitem__</b>); 1 - Select the check box if you want to use add-ons for this service<br/>(tariff includes: <b>__addonbool_value__</b>); manual - Addition value. Available only to Administrator; compound - Add-on charging method ; 2 - Add-on value including the tariff limit::<br/> - included into the tariff: <b>__limit__ __measure__</b>__intvalue_msg__ __intvalue_new_msg__ __intvalue_used_msg__ __min_msg__<br/> - maximum: <b>__max__ __measure__</b>; 3 - Select a value for the service add-on<br/>(tariff includes: <b>__enumitem__</b>); 1 - Select the check box if you want to use add-ons for this service<br/>(tariff includes: <b>__addonbool_value__</b>); manual - Addition value. Available only to Administrator; compound - Add-on charging method ; 2 - Add-on value including the tariff limit::<br/> - included into the tariff: <b>__limit__ __measure__</b>__intvalue_msg__ __intvalue_new_msg__ __intvalue_used_msg__ __min_msg__<br/> - maximum: <b>__max__ __measure__</b>; 3 - Select a value for the service add-on<br/>(tariff includes: <b>__enumitem__</b>); 1 - Select the check box if you want to use add-ons for this service<br/>(tariff includes: <b>__addonbool_value__</b>); manual - Addition value. Available only to Administrator; compound - Add-on charging method ; 2 - Add-on value including the tariff limit::<br/> - included into the tariff: <b>__limit__ __measure__</b>__intvalue_msg__ __intvalue_new_msg__ __intvalue_used_msg__ __min_msg__<br/> - maximum: <b>__max__ __measure__</b>; 3 - Select a value for the service add-on<br/>(tariff includes: <b>__enumitem__</b>); 1 - Select the check box if you want to use add-ons for this service<br/>(tariff includes: <b>__addonbool_value__</b>); manual - Addition value. Available only to Administrator; compound - Add-on charging method ; 2 - Add-on value including the tariff limit::<br/> - included into the tariff: <b>__limit__ __measure__</b>__intvalue_msg__ __intvalue_new_msg__ __intvalue_used_msg__ __min_msg__<br/> - maximum: <b>__max__ __measure__</b>; 3 - Select a value for the service add-on<br/>(tariff includes: <b>__enumitem__</b>); 1 - Select the check box if you want to use add-ons for this service<br/>(tariff includes: <b>__addonbool_value__</b>); manual - Addition value. Available only to Administrator; compound - Add-on charging method ; 2 - Add-on value including the tariff limit::<br/> - included into the tariff: <b>__limit__ __measure__</b>__intvalue_msg__ __intvalue_new_msg__ __intvalue_used_msg__ __min_msg__<br/> - maximum: <b>__max__ __measure__</b>; 3 - Select a value for the service add-on<br/>(tariff includes: <b>__enumitem__</b>); 1 - Select the check box if you want to use add-ons for this service<br/>(tariff includes: <b>__addonbool_value__</b>)", "example": "" }, "scaletype": { "type": "string", "enum": [ "3", "2", "1", "0" ], "description": "This parameter is used to calculate add-on price ; 3 - Possible values ; 2 - Value packages ; 1 - Per each scale step; 0 - By the nearest value ", "example": "" }, "restrictclientchange": { "type": "string", "enum": [ "downonly", "off", "on", "uponly" ], "description": "Resources modification policy ; downonly - Only downgrade ; off - Can be modified ; on - Cannot be modified ; uponly - Only upgrade ", "example": "" }, "minperiodtype": { "type": "string", "enum": [ "0", "1", "2", "0", "1", "2", "0", "1", "2", "0", "1", "2", "0", "1", "2", "0", "1", "2", "0", "1", "2" ], "description": "Select a minimum period that will pass before a client will be able to downgrade his add-on ; 0 - Unlimited; 1 - Month; 2 - Day; 0 - Unlimited; 1 - Month; 2 - Day; 0 - Unlimited; 1 - Month; 2 - Day; 0 - Unlimited; 1 - Month; 2 - Day; 0 - Unlimited; 1 - Month; 2 - Day; 0 - Unlimited; 1 - Month; 2 - Day; 0 - Unlimited; 1 - Month; 2 - Day", "example": "" }, "minperiodlen": { "type": "string", "description": "Enter the minimum order period for this add-on", "example": "1" }, "manualprocessing": { "type": "string", "enum": [ "on", "off" ], "description": "The service will be set up manually. The corresponding task will be created for a technical support team ", "example": "off" }, "manualprocessing_skipdefault": { "type": "string", "enum": [ "on", "off" ], "description": "With this option enabled and the default value selected, this add-on will not be added to manual processing.", "example": "off" }, "manualname": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to use the value specified below for a new add-on", "example": "off" }, "name": { "type": "string", "description": "Enter the tariff plan name", "example": "text" }, "intname": { "type": "string", "description": "Enter the internal name, only if the it differs from the internal name of the add-on type, or if several parameters should be calculated", "example": "" }, "processing_feature": { "type": "string", "description": "If you choose an addon with this feature, the handler will be selected that has this feature", "example": "" }, "roundtype": { "type": "string", "enum": [ "2", "0", "1" ], "description": "Select a rounding procedure ; 2 - Rounding downward; 0 - Mathematically ; 1 - Rounding upward ", "example": "" }, "addonstattype": { "type": "string", "enum": [ "1", "2", "period_2", "period_1", "period_2", "period_1", "period_2", "period_1", "period_2", "period_1", "period_2", "period_1", "period_2", "period_1" ], "description": "Select a period to bill a client for resource overuse; 1 - Per calendar month; 2 - Per day; period_2 - day; period_1 - month; period_2 - day; period_1 - month; period_2 - day; period_1 - month; period_2 - day; period_1 - month; period_2 - day; period_1 - month; period_2 - day; period_1 - month", "example": "" }, "addonstatcomparison": { "type": "string", "enum": [ "1", "2" ], "description": "Select how you want to bill a client if there are several parameters of the same type. For example, traffic can be incoming and outgoing; 1 - Sum; 2 - Maximum value", "example": "" }, "addonstatcalculation": { "type": "string", "enum": [ "0", "1" ], "description": "The price is specified for... If it is specified per item per month, the statistics will be calculated as follows: (overuse per day) * (price) / (number of days in a month); 0 - Item; 1 - item per month", "example": "" }, "addonstatchargestoped": { "type": "string", "enum": [ "on", "off" ], "description": "If this option is enabled, service will be charged even if it is suspended", "example": "off" }, "allowpostpaid": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to charge a client for resource overage without debiting his personal account ", "example": "off" }, "summarizeinvoice": { "type": "string", "enum": [ "on", "off" ], "description": "Sum up the values for the whole period ", "example": "off" }, "measure": { "type": "string", "description": "Select a unit of measure for this add-on. The value will be converted into a unit of measure used by the control panel ", "example": "" }, "addonlimit": { "type": "string", "description": "Default value for add-on ", "example": "0" }, "addonstep": { "type": "string", "description": "Add-on order step ", "example": "1" }, "addonmin": { "type": "string", "description": "Minimum order value. This value cannot be smaller than the value included into the tariff plan ", "example": "0" }, "addonmax": { "type": "string", "description": "Enter the maximum order value ", "example": "0" }, "addonlimittrial": { "type": "string", "description": "The default value for the add-on on a trial period", "example": "0" }, "addonmaxtrial": { "type": "string", "description": "Maximum value that can be ordered on a trial period ", "example": "0" }, "enumeration": { "type": "string", "description": "Values for add-on will be taken from this enumeration ", "example": "" }, "enumerationitem": { "type": "string", "description": "Enumeration element that this service includes by default", "example": "" }, "orderpolicy": { "type": "string", "enum": [ "0", "1", "0", "1", "0", "1", "0", "1", "0", "1", "0", "1", "0", "1" ], "description": "Here you can add rules how to calculate the price if you change service add-on ; 0 - difference in prices; 1 - full price; 0 - Price before a service expiration date; 1 - Full price over the whole period ; 0 - Price before a service expiration date; 1 - Full price over the whole period ; 0 - Price before a service expiration date; 1 - Full price over the whole period ; 0 - Price before a service expiration date; 1 - Full price over the whole period ; 0 - Price before a service expiration date; 1 - Full price over the whole period ; 0 - Price before a service expiration date; 1 - Full price over the whole period ", "example": "" }, "addonbool": { "type": "string", "enum": [ "on", "off" ], "description": "Default value for add-on ", "example": "off" }, "orderpriority": { "type": "string", "description": "Set priority for this add-on", "example": "1" }, "hideinorder": { "type": "string", "enum": [ "on", "off" ], "description": "When this option is enabled, the resource will not be displayed in the order lists", "example": "off" }, "order_img_upload": { "type": "string", "description": "Upload icon", "example": "" } } }, "PricelistDetailEnumElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "price": { "type": "string", "description": "Price" }, "orderpriority": { "type": "string" }, "status": { "type": "string" }, "disabled": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Not available for order \"; value \"off\": \"Available for order \"" }, "is_default": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Default value \"" } } }, "PricelistDetailEnum": { "type": "object", "properties": { "orderpriority": { "type": "string", "description": "Sorting order for enumeration element in the list ", "example": "1" } } }, "PricelistDetailIntegerElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "value": { "type": "string", "description": "Special prices will be applied when a client orders the specified amount of resources " }, "price": { "type": "string", "description": "Resource unit special price " } } }, "PricelistDetailIntegerNew": { "type": "object", "properties": {} }, "PricelistDetailInteger": { "type": "object", "properties": {} }, "PricelistDetailCompoundElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "price": { "type": "string", "description": "Add-on unit price " }, "orderpriority": { "type": "string", "description": "Set priority for the selected tariff add-on (count forward)" }, "status": { "type": "string", "description": "Add-on current status" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" }, "manualprocessing": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "restrictclientchange": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "has_scale": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" } } }, "PricelistHistoryElem": { "type": "object", "properties": { "changedate": { "type": "string" }, "desc": { "type": "string", "description": "Tariff description" }, "user": { "type": "string" }, "ip": { "type": "string" }, "action": { "type": "string" } } }, "PricelistChangeElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Tariff name " }, "status": { "type": "string", "description": "Shows if the tariff plan can be upgraded or downgraded" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" } } }, "PricelistChangeRuleElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "fromdate": { "type": "string", "description": "Period start date. If the service was ordered within this period, a discount will be given when upgrading the tariff plan " }, "todate": { "type": "string", "description": "Period end date date. If the service was ordered within this period, a discount will be given when upgrading the tariff plan " }, "period": { "type": "string", "description": "This discount will be given on selected periods" }, "discount": { "type": "string", "description": "discount in % that is given to a client when he changes his tariff plan during the specified period " } } }, "PricelistChangeRuleNew": { "type": "object", "properties": { "fromdate": { "type": "string", "description": "Start date. The rule will be applied only to services that were ordered after this date ", "example": "text" }, "todate": { "type": "string", "description": "End date. The rule will be applied only to services that were ordered before this date ", "example": "text" }, "period": { "type": "string", "enum": [ "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60" ], "description": "You can create different rules depending on order period (lifetime, one month, etc.); num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years", "example": "" }, "discount": { "type": "string", "description": "Enter a discount in % that will be given on a new product", "example": "text" } } }, "PricelistChangeRule": { "type": "object", "properties": { "fromdate": { "type": "string", "description": "Start date. The rule will be applied only to services that were ordered after this date ", "example": "text" }, "todate": { "type": "string", "description": "End date. The rule will be applied only to services that were ordered before this date ", "example": "text" }, "period": { "type": "string", "enum": [ "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60" ], "description": "You can create different rules depending on order period (lifetime, one month, etc.); num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years", "example": "" }, "discount": { "type": "string", "description": "Enter a discount in % that will be given on a new product", "example": "text" } } }, "PricelistReferenceElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "referencedesc": { "type": "string", "description": "Correspondence between add-ons of the tariff plan" }, "reference": { "type": "string", "description": "Correspondence between add-ons of tariff plans " } } }, "PricelistReferenceNew": { "type": "object", "properties": { "pricelist_base": { "type": "string", "description": "Select a tariff add-on. Modifying this add-on will modify the value of the dependent add-on ", "example": "" }, "enumerationitem_base": { "type": "string", "description": "Select a value. Selecting the value will modify the dependent add-on ", "example": "" }, "pricelist_reference": { "type": "string", "description": "Select an add-on that will be changed when changing the main add-on ", "example": "" }, "enumerationitem_reference": { "type": "string", "description": "Select values that will be available when changing the main add-on ", "example": "" } } }, "PricelistReference": { "type": "object", "properties": { "pricelist_base": { "type": "string", "description": "Select a tariff add-on. Modifying this add-on will modify the value of the dependent add-on ", "example": "" }, "enumerationitem_base": { "type": "string", "description": "Select a value. Selecting the value will modify the dependent add-on ", "example": "" }, "pricelist_reference": { "type": "string", "description": "Select an add-on that will be changed when changing the main add-on ", "example": "" }, "enumerationitem_reference": { "type": "string", "description": "Select values that will be available when changing the main add-on ", "example": "" } } }, "PricelistReferenceClone": { "type": "object", "properties": {} }, "ItemtypeElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "intname": { "type": "string" }, "orderpriority": { "type": "string", "description": "Set priority for this product type (count forward)" } } }, "ItemtypeNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter a product type name ", "example": "text" }, "description": { "type": "string", "description": "Brief description of the product type when ordering the service", "example": "" }, "intname": { "type": "string", "description": "Internal name is used for identification. Processing modules are selected based on this internal name ", "example": "text" }, "trialtype": { "type": "string", "enum": [ "0", "1", "2", "3" ], "description": "Select how you want to allow trial versions ; 0 - One per this product type; 1 - One in every product group; 2 - One per tariff plan; 3 - For every service", "example": "" }, "splitexpense": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to distribute expenses. E.g. when a client pays for one year, the billing system will generate 12 or 13 expenses per each month during which client's service remains active. ", "example": "off" }, "nostopholidays": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box not to suspend clientsэ services on weekends (Saturdays and Sundays)", "example": "off" }, "orderpriority": { "type": "string", "description": "Set priority for product types", "example": "" }, "open_duration_limit": { "type": "string", "description": "The service should be processed during this period. Format: hh:mm ", "example": "" }, "list_img_upload": { "type": "string", "description": "Service list icon ", "example": "" }, "suspendperiod": { "type": "string", "description": "Period in days that will pass before a suspended unpaid service will be deleted", "example": "1" }, "closetype": { "type": "string", "enum": [ "0", "1", "2" ], "description": "Service deletion policy for clients ; 0 - Client can delete services ; 1 - Client cannot delete services ; 2 - Client can delete services upon phone verification", "example": "" }, "closesubtype": { "type": "string", "enum": [ "0", "1" ], "description": "Service deletion rules (if service is deleted by client); 0 - Delete immediately ; 1 - After paid period ", "example": "" }, "trial": { "type": "string", "enum": [ "on", "off" ], "description": "Trial periods can be activated for this product ", "example": "off" }, "day": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for one day", "example": "off" }, "accurate_billing": { "type": "string", "enum": [ "not_less", "hours", "no" ], "description": "The setting affects the payment cycle pattern for services with a period of 1 day. To configure the behavior, select one of the following options:<br/><br/>\n- General withdrawal scheme - in this case the renewal of services will be according to the general withdrawal scheme once a day. By default at 00:15<br/><br/>\n- Full day - in this case the service renewal will not be attempted before the service validity time. By default, the task to renew expiring services is launched every 30 minutes<br/><br/>\n- Full day (to the nearest hour) - in this case the attempt to extend the services will be made not earlier than the hour of service validity. By default, the task to extend expiring services is launched every 30 minutes; not_less - Full day; hours - Full day (to the nearest hour); no - General withdrawal scheme", "example": "" }, "monthly": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for one month ", "example": "off" }, "quarterly": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for three years ", "example": "off" }, "semiannual": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for half a year ", "example": "off" }, "annually": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for one year ", "example": "off" }, "biennial": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for two years ", "example": "off" }, "triennial": { "type": "string", "enum": [ "on", "off" ], "description": "Three years", "example": "off" }, "quadrennial": { "type": "string", "enum": [ "on", "off" ], "description": "This period can be ordered for four years ", "example": "off" }, "quinquennial": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for five years ", "example": "off" }, "decennial": { "type": "string", "enum": [ "on", "off" ], "description": "Enable the selected period of 10 years ", "example": "off" }, "lifetime": { "type": "string", "enum": [ "on", "off" ], "description": "One-time fee ", "example": "off" }, "transfer": { "type": "string", "enum": [ "on", "off" ], "description": "Enable transfer ", "example": "off" }, "orderview": { "type": "string", "enum": [ "0", "1" ], "description": "You can change the way how tariff plans are located in a service order form. You can modify tariff description in its edit form ; 0 - List; 1 - Blocks", "example": "" }, "fulldescription": { "type": "string", "enum": [ "on", "off" ], "description": "When this option is enabled, the tariff description for this product type will not be minimized on order forms", "example": "off" }, "order_img_upload": { "type": "string", "description": "Icon ", "example": "" }, "show_addon_image": { "type": "string", "enum": [ "on", "off" ], "description": "This option enables to configure and display resources' icons during service order and modification", "example": "off" } } }, "Itemtype": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter a product type name ", "example": "text" }, "description": { "type": "string", "description": "Brief description of the product type when ordering the service", "example": "" }, "intname": { "type": "string", "description": "Internal name is used for identification. Processing modules are selected based on this internal name ", "example": "text" }, "trialtype": { "type": "string", "enum": [ "0", "1", "2", "3" ], "description": "Select how you want to allow trial versions ; 0 - One per this product type; 1 - One in every product group; 2 - One per tariff plan; 3 - For every service", "example": "" }, "splitexpense": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to distribute expenses. E.g. when a client pays for one year, the billing system will generate 12 or 13 expenses per each month during which client's service remains active. ", "example": "off" }, "nostopholidays": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box not to suspend clientsэ services on weekends (Saturdays and Sundays)", "example": "off" }, "orderpriority": { "type": "string", "description": "Set priority for product types", "example": "" }, "open_duration_limit": { "type": "string", "description": "The service should be processed during this period. Format: hh:mm ", "example": "" }, "list_img_upload": { "type": "string", "description": "Service list icon ", "example": "" }, "suspendperiod": { "type": "string", "description": "Period in days that will pass before a suspended unpaid service will be deleted", "example": "1" }, "closetype": { "type": "string", "enum": [ "0", "1", "2" ], "description": "Service deletion policy for clients ; 0 - Client can delete services ; 1 - Client cannot delete services ; 2 - Client can delete services upon phone verification", "example": "" }, "closesubtype": { "type": "string", "enum": [ "0", "1" ], "description": "Service deletion rules (if service is deleted by client); 0 - Delete immediately ; 1 - After paid period ", "example": "" }, "trial": { "type": "string", "enum": [ "on", "off" ], "description": "Trial periods can be activated for this product ", "example": "off" }, "day": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for one day", "example": "off" }, "accurate_billing": { "type": "string", "enum": [ "not_less", "hours", "no" ], "description": "The setting affects the payment cycle pattern for services with a period of 1 day. To configure the behavior, select one of the following options:<br/><br/>\n- General withdrawal scheme - in this case the renewal of services will be according to the general withdrawal scheme once a day. By default at 00:15<br/><br/>\n- Full day - in this case the service renewal will not be attempted before the service validity time. By default, the task to renew expiring services is launched every 30 minutes<br/><br/>\n- Full day (to the nearest hour) - in this case the attempt to extend the services will be made not earlier than the hour of service validity. By default, the task to extend expiring services is launched every 30 minutes; not_less - Full day; hours - Full day (to the nearest hour); no - General withdrawal scheme", "example": "" }, "monthly": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for one month ", "example": "off" }, "quarterly": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for three years ", "example": "off" }, "semiannual": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for half a year ", "example": "off" }, "annually": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for one year ", "example": "off" }, "biennial": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for two years ", "example": "off" }, "triennial": { "type": "string", "enum": [ "on", "off" ], "description": "Three years", "example": "off" }, "quadrennial": { "type": "string", "enum": [ "on", "off" ], "description": "This period can be ordered for four years ", "example": "off" }, "quinquennial": { "type": "string", "enum": [ "on", "off" ], "description": "This product can be ordered for five years ", "example": "off" }, "decennial": { "type": "string", "enum": [ "on", "off" ], "description": "Enable the selected period of 10 years ", "example": "off" }, "lifetime": { "type": "string", "enum": [ "on", "off" ], "description": "One-time fee ", "example": "off" }, "transfer": { "type": "string", "enum": [ "on", "off" ], "description": "Enable transfer ", "example": "off" }, "orderview": { "type": "string", "enum": [ "0", "1" ], "description": "You can change the way how tariff plans are located in a service order form. You can modify tariff description in its edit form ; 0 - List; 1 - Blocks", "example": "" }, "fulldescription": { "type": "string", "enum": [ "on", "off" ], "description": "When this option is enabled, the tariff description for this product type will not be minimized on order forms", "example": "off" }, "order_img_upload": { "type": "string", "description": "Icon ", "example": "" }, "show_addon_image": { "type": "string", "enum": [ "on", "off" ], "description": "This option enables to configure and display resources' icons during service order and modification", "example": "off" } } }, "PricelistgroupElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "project": { "type": "string", "description": "Tariff group provider " }, "itemtype": { "type": "string", "description": "Product type associated with the group " } } }, "PricelistgroupNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter a group name", "example": "text" }, "project": { "type": "string", "enum": [ "list" ], "description": "Select a provider this group is assigned to; list - Provider", "example": "" }, "itemtype": { "type": "string", "enum": [ "settings", "settings", "settings", "settings" ], "description": "Product type associated with this group; settings - Additional settings; settings - Additional settings; settings - Additional settings; settings - Additional settings", "example": "" }, "itemmax": { "type": "string", "description": "Enter the maximum number of services that a client can order. A client won't be able to order add-ons for this tariff plan when he reaches this limit", "example": "1" }, "trial_itemmax": { "type": "string", "description": "The maximum number of trials available for this tariff plan", "example": "1" } } }, "Pricelistgroup": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter a group name", "example": "text" }, "itemmax": { "type": "string", "description": "Enter the maximum number of services that a client can order. A client won't be able to order add-ons for this tariff plan when he reaches this limit", "example": "1" }, "trial_itemmax": { "type": "string", "description": "The maximum number of trials available for this tariff plan", "example": "1" } } }, "PromotionElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Name to be displayed under the employee" }, "hide_from_client": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "type": { "type": "string", "description": "Promotion type" }, "fromdate": { "type": "string", "description": "Date when the promotion starts" }, "todate": { "type": "string", "description": "Promotion end date" }, "status": { "type": "string", "description": "Current status of the promotion " }, "project_name": { "type": "string", "description": "Service provider associated with this promotion " } } }, "PromotionNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Name to be displayed under the employee", "example": "text" }, "clientname": { "type": "string", "description": "Name to be displayed under the client. If it is not set, \"Discount\" or \"Special Price\" will be displayed depending on the type of discount", "example": "" }, "project": { "type": "string", "description": "Promotion provider", "example": "" }, "fromdate": { "type": "string", "description": "Start of the promotion period", "example": "text" }, "todate": { "type": "string", "description": "End of the promotion period (inclusive of the specified date)", "example": "text" }, "type": { "type": "string", "enum": [ "2", "1", "0" ], "description": "Promotion type; 2 - Cashback on payments; 1 - Top up certificate; 0 - Discounts on services", "example": "" }, "account_uselimit": { "type": "string", "description": "Specify how many times a client can use the promotion", "example": "1" }, "numtmpl_payment": { "type": "string", "description": "The template of the invoice number. You can use the following macros: {id} - payment id and {num} - invoice numerical number. If both macros are not present, {num} will be used ", "example": "" }, "min_amount_payment": { "type": "string", "description": "Minimum payment amount to receive cashback", "example": "1.00" }, "amount_percent": { "type": "string", "description": "Configuration of % from the amount of the previous payment", "example": "text" }, "amount_max": { "type": "string", "description": "Maximum cashback amount", "example": "" }, "paymethod": { "type": "string", "enum": [ "description", "name", "nullmsg" ], "description": "Payment methods based on which cashback will be accrued; description - Addition to the description of the payment method; name - Addition to the name of the payment method; nullmsg - -- all --", "example": "" }, "hide_from_client": { "type": "string", "enum": [ "on", "off" ], "description": "Promotion discounts will not be displayed to clients in the discount list and in calculations", "example": "off" } } }, "Promotion": { "type": "object", "properties": { "name": { "type": "string", "description": "Name to be displayed under the employee", "example": "text" }, "clientname": { "type": "string", "description": "Name to be displayed under the client. If it is not set, \"Discount\" or \"Special Price\" will be displayed depending on the type of discount", "example": "" }, "fromdate": { "type": "string", "description": "Start of the promotion period", "example": "text" }, "todate": { "type": "string", "description": "End of the promotion period (inclusive of the specified date)", "example": "text" }, "type": { "type": "string", "enum": [ "2", "1", "0" ], "description": "Promotion type; 2 - Cashback on payments; 1 - Top up certificate; 0 - Discounts on services", "example": "" }, "account_uselimit": { "type": "string", "description": "Specify how many times a client can use the promotion", "example": "1" }, "numtmpl_payment": { "type": "string", "description": "The template of the invoice number. You can use the following macros: {id} - payment id and {num} - invoice numerical number. If both macros are not present, {num} will be used ", "example": "" }, "min_amount_payment": { "type": "string", "description": "Minimum payment amount to receive cashback", "example": "1.00" }, "amount_percent": { "type": "string", "description": "Configuration of % from the amount of the previous payment", "example": "text" }, "amount_max": { "type": "string", "description": "Maximum cashback amount", "example": "" }, "paymethod": { "type": "string", "enum": [ "description", "name", "nullmsg" ], "description": "Payment methods based on which cashback will be accrued; description - Addition to the description of the payment method; name - Addition to the name of the payment method; nullmsg - -- all --", "example": "" }, "hide_from_client": { "type": "string", "enum": [ "on", "off" ], "description": "Promotion discounts will not be displayed to clients in the discount list and in calculations", "example": "off" } } }, "PromotionDiscountElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "products": { "type": "string", "description": "Applies to goods/services" }, "value": { "type": "string", "description": "Discount amount / special price" }, "actiontype": { "type": "string", "description": "Select a discount type. Please note, that discount given on renewal cannot be given on tariff plans with daily charges " }, "applicable_for": { "type": "string", "description": "Discount application method" } } }, "PromotionDiscountNew": { "type": "object", "properties": { "tree_or_input": { "type": "string", "enum": [ "0", "1" ], "description": "; 0 - Product types/tariffs; 1 - Services", "example": "" }, "item_ids": { "type": "string", "description": "Service ID", "example": "1" }, "type": { "type": "string", "enum": [ "0", "1" ], "description": "Select a discount type; 0 - Percentage discount; 1 - Special price", "example": "" }, "percentage": { "type": "string", "description": "Discount in % on product/service", "example": "0.0" }, "actiontype": { "type": "string", "enum": [ "2", "0", "1", "2", "0", "1" ], "description": "Select a discount type. Please note, that discount given on renewal cannot be given on tariff plans with daily charges ; 2 - Renewal; 0 - Order and renewal; 1 - Order; 2 - Renewal; 0 - Order and renewal; 1 - Order", "example": "" }, "applicable_for": { "type": "string", "enum": [ "2", "1", "0", "2", "1", "0" ], "description": "Discount application method; 2 - To additional resources; 1 - To the base cost of the tariff; 0 - To the total cost of the service; 2 - To additional resources; 1 - To the base cost of the tariff; 0 - To the total cost of the service", "example": "" }, "period": { "type": "string", "enum": [ "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60" ], "description": "This discount will be given on selected periods; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years", "example": "" }, "validity": { "type": "string", "enum": [ "2", "0", "1" ], "description": "Select a discount validity period; 2 - For the first order period (daily charges) ; 0 - The whole period; 1 - Several first months", "example": "" }, "validitylength": { "type": "string", "description": "Select a discount validity period", "example": "1" }, "account_uselimit": { "type": "string", "description": "Specify how many times the client can use the discount", "example": "1" } } }, "PromotionDiscount": { "type": "object", "properties": { "tree_or_input": { "type": "string", "enum": [ "0", "1" ], "description": "; 0 - Product types/tariffs; 1 - Services", "example": "" }, "item_ids": { "type": "string", "description": "Service ID", "example": "1" }, "type": { "type": "string", "enum": [ "0", "1" ], "description": "Select a discount type; 0 - Percentage discount; 1 - Special price", "example": "" }, "percentage": { "type": "string", "description": "Discount in % on product/service", "example": "0.0" }, "actiontype": { "type": "string", "enum": [ "2", "0", "1", "2", "0", "1" ], "description": "Select a discount type. Please note, that discount given on renewal cannot be given on tariff plans with daily charges ; 2 - Renewal; 0 - Order and renewal; 1 - Order; 2 - Renewal; 0 - Order and renewal; 1 - Order", "example": "" }, "applicable_for": { "type": "string", "enum": [ "2", "1", "0", "2", "1", "0" ], "description": "Discount application method; 2 - To additional resources; 1 - To the base cost of the tariff; 0 - To the total cost of the service; 2 - To additional resources; 1 - To the base cost of the tariff; 0 - To the total cost of the service", "example": "" }, "period": { "type": "string", "enum": [ "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60" ], "description": "This discount will be given on selected periods; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years", "example": "" }, "validity": { "type": "string", "enum": [ "2", "0", "1" ], "description": "Select a discount validity period; 2 - For the first order period (daily charges) ; 0 - The whole period; 1 - Several first months", "example": "" }, "validitylength": { "type": "string", "description": "Select a discount validity period", "example": "1" }, "account_uselimit": { "type": "string", "description": "Specify how many times the client can use the discount", "example": "1" } } }, "PromotionConditionElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "condition": { "type": "string", "description": "Condition for participation in the promotion" }, "cgroup": { "type": "string", "description": "Conditions will be grouped by the OR operator. The groups can be associated with each other by the AND operator. E.g. A, B, and C conditions are included into one group, and D and E conditions are included into another group. The result is (A OR B OR С) AND (D OR E)" } } }, "PromotionConditionNew": { "type": "object", "properties": { "ctype": { "type": "string", "enum": [ "72", "71", "61", "51", "50", "12", "110", "11", "100", "0", "1", "10", "2", "3", "4", "5", "6", "7", "8", "9", "72", "71", "61", "51", "50", "12", "110", "11", "100", "0", "1", "10", "2", "3", "4", "5", "6", "7", "8", "9" ], "description": "Promotion will be active, if the selected condition is met ; 72 - Registration date; 71 - Date of order/activation of the first service; 61 - Use certificates to add funds to account balance; 51 - Service expiration date; 50 - Service order/activation date; 12 - Presence of recurring payment and auto-renewal; 110 - Amount of expenses by the selected providers over the period ; 11 - Period from ordering/activation of the first service; 100 - Service IP address from a hosting partner's IP range ; 0 - No conditions; 1 - Number of paid services; 10 - Payments per year; 2 - Period from the registration date; 3 - Number of services; 4 - Has product/service; 5 - Expenses over period; 6 - Payments over period; 7 - Promo code; 8 - Affiliate program; 9 - Client groups; 72 - Registration date; 71 - Date of order/activation of the first service; 61 - Use certificates to add funds to account balance; 51 - Service expiration date; 50 - Service order/activation date; 12 - Presence of recurring payment and auto-renewal; 110 - Amount of expenses by the selected providers over the period ; 11 - Period from ordering/activation of the first service; 100 - Service IP address from a hosting partner's IP range ; 0 - No conditions; 1 - Number of paid services; 10 - Payments per year; 2 - Period from the registration date; 3 - Number of services; 4 - Has product/service; 5 - Expenses over period; 6 - Payments over period; 7 - Promo code; 8 - Affiliate program; 9 - Client groups", "example": "" }, "item_periods": { "type": "string", "description": "Order periods", "example": "" }, "item_statuses": { "type": "string", "enum": [ "5", "2", "4", "3", "1" ], "description": "Statuses of services that are subject to the conditions; 5 - Processing; 2 - Active; 4 - Deleted; 3 - Suspended; 1 - Ordered", "example": "" }, "only_payd": { "type": "string", "enum": [ "on", "off" ], "description": "Only services for which there is at least one expense will be considered", "example": "off" }, "coupon_promotion": { "type": "string", "description": "Promotion, the certificate from which must be used to verify the condition", "example": "" }, "coupon": { "type": "string", "enum": [ "promotion" ], "description": "The certificate that will be used to check the rule; promotion - Promotion", "example": "" }, "comparison": { "type": "string", "description": "Comparison condition ", "example": "" }, "amount": { "type": "string", "description": "Number of services of the selected type or tariff plan", "example": "0" }, "period": { "type": "string", "enum": [ "specification", "specification_2", "specification_1", "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60" ], "description": "Order period; specification - Period specification type; specification_2 - Date range; specification_1 - Time range; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years", "example": "" }, "period_specification": { "type": "string", "enum": [ "2", "1" ], "description": "The method which is used to specify a period; 2 - Date range; 1 - Time range", "example": "" }, "periodtype": { "type": "string", "enum": [ "3", "0", "1", "2" ], "description": "Period type; 3 - Year; 0 - the whole period ; 1 - Day; 2 - Month", "example": "" }, "periodlength": { "type": "string", "description": "Period length", "example": "1" }, "selectedproject": { "type": "string", "enum": [ "nullmsg" ], "description": "; nullmsg - -- select provider --", "example": "" }, "summa": { "type": "string", "description": "Amount in the selected currency", "example": "text" }, "currency": { "type": "string", "description": "Select currency", "example": "" }, "fixedcurrencyrate": { "type": "string", "enum": [ "on", "off" ], "description": "The fixed currency rate will be used instead of the current one for calculating the expenses amount ", "example": "off" }, "currencyrate": { "type": "string", "description": "Rate of the selected currency", "example": "1.00" }, "affiliate": { "type": "string", "description": "Clients who were referred by the referral link will be able to participate in promotion", "example": "" }, "account_groups": { "type": "string", "enum": [ "nullmsg" ], "description": "To be able to use the promotion, the client must be a member of one of the selected groups; nullmsg - -- choose client group --", "example": "" }, "fromdate": { "type": "string", "description": "Period start date ", "example": "text" }, "todate": { "type": "string", "description": "Period end date ", "example": "text" }, "group": { "type": "string", "enum": [ "new", "none" ], "description": "You can group conditions. The conditions will be grouped by the OR operator. The groups can be associated with each other by the AND operator. E.g. A, B, and C conditions are included into one group, and D and E conditions are included into another group. The result is (A OR B OR С) AND (D OR E); new - Add a new group of conditions; none - Without group", "example": "" }, "groupname": { "type": "string", "description": "Enter the name of the conditions group", "example": "text" } } }, "PromotionCondition": { "type": "object", "properties": { "ctype": { "type": "string", "enum": [ "72", "71", "61", "51", "50", "12", "110", "11", "100", "0", "1", "10", "2", "3", "4", "5", "6", "7", "8", "9", "72", "71", "61", "51", "50", "12", "110", "11", "100", "0", "1", "10", "2", "3", "4", "5", "6", "7", "8", "9" ], "description": "Promotion will be active, if the selected condition is met ; 72 - Registration date; 71 - Date of order/activation of the first service; 61 - Use certificates to add funds to account balance; 51 - Service expiration date; 50 - Service order/activation date; 12 - Presence of recurring payment and auto-renewal; 110 - Amount of expenses by the selected providers over the period ; 11 - Period from ordering/activation of the first service; 100 - Service IP address from a hosting partner's IP range ; 0 - No conditions; 1 - Number of paid services; 10 - Payments per year; 2 - Period from the registration date; 3 - Number of services; 4 - Has product/service; 5 - Expenses over period; 6 - Payments over period; 7 - Promo code; 8 - Affiliate program; 9 - Client groups; 72 - Registration date; 71 - Date of order/activation of the first service; 61 - Use certificates to add funds to account balance; 51 - Service expiration date; 50 - Service order/activation date; 12 - Presence of recurring payment and auto-renewal; 110 - Amount of expenses by the selected providers over the period ; 11 - Period from ordering/activation of the first service; 100 - Service IP address from a hosting partner's IP range ; 0 - No conditions; 1 - Number of paid services; 10 - Payments per year; 2 - Period from the registration date; 3 - Number of services; 4 - Has product/service; 5 - Expenses over period; 6 - Payments over period; 7 - Promo code; 8 - Affiliate program; 9 - Client groups", "example": "" }, "item_periods": { "type": "string", "description": "Order periods", "example": "" }, "item_statuses": { "type": "string", "enum": [ "5", "2", "4", "3", "1" ], "description": "Statuses of services that are subject to the conditions; 5 - Processing; 2 - Active; 4 - Deleted; 3 - Suspended; 1 - Ordered", "example": "" }, "only_payd": { "type": "string", "enum": [ "on", "off" ], "description": "Only services for which there is at least one expense will be considered", "example": "off" }, "coupon_promotion": { "type": "string", "description": "Promotion, the certificate from which must be used to verify the condition", "example": "" }, "coupon": { "type": "string", "enum": [ "promotion" ], "description": "The certificate that will be used to check the rule; promotion - Promotion", "example": "" }, "comparison": { "type": "string", "description": "Comparison condition ", "example": "" }, "amount": { "type": "string", "description": "Number of services of the selected type or tariff plan", "example": "0" }, "period": { "type": "string", "enum": [ "specification", "specification_2", "specification_1", "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "num_0", "num_-100", "num_120", "num_-50", "num_1", "num_-200", "num_6", "num_36", "num_48", "num_3", "num_60", "num_24", "num_12", "short_36", "short_60", "short_12", "short_48", "short_6", "short_24", "short_-200", "short_3", "short_120", "short_-100", "short_-50", "120", "short_1", "-200", "-100", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60" ], "description": "Order period; specification - Period specification type; specification_2 - Date range; specification_1 - Time range; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years; num_0 - Lifetime ; num_-100 - Trial ; num_120 - 10 years; num_-50 - 1 day; num_1 - 1 month; num_-200 - Transfer; num_6 - Half a year; num_36 - 3 years; num_48 - 4 years; num_3 - 3 months; num_60 - 5 years; num_24 - 2 years; num_12 - 1 year; short_36 - Three years ; short_60 - Five years ; short_12 - Year ; short_48 - Four years ; short_6 - Half a year ; short_24 - Two years ; short_-200 - Transfer; short_3 - Three months ; short_120 - 10 years ; short_-100 - Trial ; short_-50 - Day ; 120 - 10 years ; short_1 - month ; -200 - Transfer ; -100 - Trial; -50 - Day; 0 - Lifetime; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - Five years", "example": "" }, "period_specification": { "type": "string", "enum": [ "2", "1" ], "description": "The method which is used to specify a period; 2 - Date range; 1 - Time range", "example": "" }, "periodtype": { "type": "string", "enum": [ "3", "0", "1", "2" ], "description": "Period type; 3 - Year; 0 - the whole period ; 1 - Day; 2 - Month", "example": "" }, "periodlength": { "type": "string", "description": "Period length", "example": "1" }, "selectedproject": { "type": "string", "enum": [ "nullmsg" ], "description": "; nullmsg - -- select provider --", "example": "" }, "summa": { "type": "string", "description": "Amount in the selected currency", "example": "text" }, "currency": { "type": "string", "description": "Select currency", "example": "" }, "fixedcurrencyrate": { "type": "string", "enum": [ "on", "off" ], "description": "The fixed currency rate will be used instead of the current one for calculating the expenses amount ", "example": "off" }, "currencyrate": { "type": "string", "description": "Rate of the selected currency", "example": "1.00" }, "affiliate": { "type": "string", "description": "Clients who were referred by the referral link will be able to participate in promotion", "example": "" }, "account_groups": { "type": "string", "enum": [ "nullmsg" ], "description": "To be able to use the promotion, the client must be a member of one of the selected groups; nullmsg - -- choose client group --", "example": "" }, "fromdate": { "type": "string", "description": "Period start date ", "example": "text" }, "todate": { "type": "string", "description": "Period end date ", "example": "text" }, "group": { "type": "string", "enum": [ "new", "none" ], "description": "You can group conditions. The conditions will be grouped by the OR operator. The groups can be associated with each other by the AND operator. E.g. A, B, and C conditions are included into one group, and D and E conditions are included into another group. The result is (A OR B OR С) AND (D OR E); new - Add a new group of conditions; none - Without group", "example": "" }, "groupname": { "type": "string", "description": "Enter the name of the conditions group", "example": "text" } } }, "PromotionClone": { "type": "object", "properties": { "name": { "type": "string", "description": "Name to be displayed under the employee", "example": "text" }, "clientname": { "type": "string", "description": "Name to be displayed under the client. If it is not set, \"Discount\" or \"Special Price\" will be displayed depending on the type of discount", "example": "" }, "fromdate": { "type": "string", "description": "Start of the promotion period", "example": "text" }, "todate": { "type": "string", "description": "End of the promotion period (inclusive of the specified date)", "example": "text" }, "type": { "type": "string", "enum": [ "2", "1", "0", "2", "1", "0" ], "description": "Promotion type; 2 - Cashback on payments; 1 - Top up certificate; 0 - Discounts on services; 2 - Cashback on payments; 1 - Top up certificate; 0 - Discounts on services", "example": "" }, "account_uselimit": { "type": "string", "description": "Specify how many times a client can use the promotion", "example": "1" }, "numtmpl_payment": { "type": "string", "description": "The template of the invoice number. You can use the following macros: {id} - payment id and {num} - invoice numerical number. If both macros are not present, {num} will be used ", "example": "" }, "min_amount_payment": { "type": "string", "description": "Minimum payment amount to receive cashback", "example": "1.00" }, "amount_percent": { "type": "string", "description": "Configuration of % from the amount of the previous payment", "example": "text" }, "amount_max": { "type": "string", "description": "Maximum cashback amount", "example": "" }, "paymethod": { "type": "string", "enum": [ "description", "name", "nullmsg", "description", "name", "nullmsg" ], "description": "Payment methods based on which cashback will be accrued; description - Addition to the description of the payment method; name - Addition to the name of the payment method; nullmsg - -- all --; description - Addition to the description of the payment method; name - Addition to the name of the payment method; nullmsg - -- all --", "example": "" }, "hide_from_client": { "type": "string", "enum": [ "on", "off" ], "description": "Promotion discounts will not be displayed to clients in the discount list and in calculations", "example": "off" } } }, "PromotionHistoryElem": { "type": "object", "properties": { "changedate": { "type": "string" }, "desc": { "type": "string" }, "user": { "type": "string" }, "ip": { "type": "string" }, "action": { "type": "string" } } }, "PromotionArchivedElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Name to be displayed under the employee" }, "type": { "type": "string", "description": "Promotion type" }, "fromdate": { "type": "string", "description": "Date when the promotion starts" }, "todate": { "type": "string", "description": "Promotion end date" }, "status": { "type": "string", "description": "Current status of the promotion " }, "project_name": { "type": "string", "description": "Service provider associated with this promotion " } } }, "PromotionPromocodeElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "code": { "type": "string", "description": "Alpha-numeric sequence of promo code, which can be used by your clients " }, "uselimit": { "type": "string", "description": "Promo code usage limit " }, "use_count": { "type": "string", "description": "How many times this promo code was used " }, "status": { "type": "string", "description": "Promo code/certificate status" } } }, "PromotionPromocodeNew": { "type": "object", "properties": { "code": { "type": "string", "description": "Promo code template. The \"?\" signs will be changed into random values while generating a new promo code", "example": "text" }, "count": { "type": "string", "description": "Enter the number of promo codes you want to generate", "example": "1" }, "uselimit": { "type": "string", "description": "How many times this promo code can be used", "example": "1" }, "account_uselimit": { "type": "string", "description": "How many times a client can use this promo code ", "example": "1" }, "onlydigit": { "type": "string", "enum": [ "on", "off" ], "description": "Only digits will be used to generate a random number ", "example": "off" }, "active_time_type": { "type": "string", "description": "Period when the promo code can be activated ", "example": "" }, "fromdate": { "type": "string", "description": "Enter the promo code start date ", "example": "text" }, "todate": { "type": "string", "description": "Promo code expiration date ", "example": "text" }, "expiretype": { "type": "string", "enum": [ "0", "1" ], "description": "The promo code's discount can be used during the specified period ; 0 - Service order period ; 1 - Specified period ", "example": "" }, "periodtype": { "type": "string", "enum": [ "3", "1", "2" ], "description": "Period type; 3 - Year; 1 - Day; 2 - Month", "example": "" }, "periodlength": { "type": "string", "description": "Period length", "example": "1" } } }, "PromotionPromocode": { "type": "object", "properties": { "code": { "type": "string", "description": "Promo code template. The \"?\" signs will be changed into random values while generating a new promo code", "example": "text" }, "uselimit": { "type": "string", "description": "How many times this promo code can be used", "example": "1" }, "account_uselimit": { "type": "string", "description": "How many times a client can use this promo code ", "example": "1" }, "active_time_type": { "type": "string", "description": "Period when the promo code can be activated ", "example": "" }, "fromdate": { "type": "string", "description": "Enter the promo code start date ", "example": "text" }, "todate": { "type": "string", "description": "Promo code expiration date ", "example": "text" }, "expiretype": { "type": "string", "enum": [ "0", "1" ], "description": "The promo code's discount can be used during the specified period ; 0 - Service order period ; 1 - Specified period ", "example": "" }, "periodtype": { "type": "string", "enum": [ "3", "1", "2" ], "description": "Period type; 3 - Year; 1 - Day; 2 - Month", "example": "" }, "periodlength": { "type": "string", "description": "Period length", "example": "1" } } }, "PromocodeUsageElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Service Id" }, "account_id": { "type": "string" }, "account": { "type": "string", "description": "Client who used the promo code " }, "status": { "type": "string", "description": "Service status" }, "expense": { "type": "string", "description": "Expenses " } } }, "PromotionCouponElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "code": { "type": "string", "description": "Alphanumeric consequence of the certificate. It can be provided to a client" }, "amount": { "type": "string", "description": "Amount of funds that will be added to the account balance" }, "uselimit": { "type": "string", "description": "Certificate usage limit" }, "use_count": { "type": "string", "description": "How many times the certificate was used" }, "payment_expire": { "type": "string", "description": "The validity period of the payment associated with the certificate" }, "status": { "type": "string", "description": "Promo code/certificate status" } } }, "PromotionCouponNew": { "type": "object", "properties": { "code": { "type": "string", "description": "Alphanumeric consequence of the certificate. It can be provided to a client", "example": "text" }, "onlydigit": { "type": "string", "enum": [ "on", "off" ], "description": "Only digits will be used to generate a random number ", "example": "off" }, "count": { "type": "string", "description": "Enter the number of promo codes you want to generate", "example": "1" }, "amount_type": { "type": "string", "enum": [ "2", "1" ], "description": "The amount can be fixed or calculated by parameters; 2 - by amount of the last payment; 1 - fixed", "example": "" }, "amount": { "type": "string", "description": "Amount of funds that will be added to the account balance", "example": "text" }, "amount_percent": { "type": "string", "description": "Configuration of % from the amount of the previous payment", "example": "text" }, "amount_max": { "type": "string", "description": "The maximum amount that can be used when calculating by the last payment", "example": "text" }, "uselimit": { "type": "string", "description": "Certificate usage limit", "example": "1" }, "account_uselimit": { "type": "string", "description": "How many times a client can use this promo code ", "example": "1" }, "expire_period_specification": { "type": "string", "enum": [ "2", "1", "0" ], "description": "Configuration of the period when the funds can be used; 2 - till the specified date; 1 - during the specified period; 0 - unlimited", "example": "" }, "expire_date": { "type": "string", "description": "The funds can be used till this date (including)", "example": "text" }, "expire_period": { "type": "string", "description": "The funds can be used during the specified period", "example": "1" } } }, "PromotionCoupon": { "type": "object", "properties": { "code": { "type": "string", "description": "Alphanumeric consequence of the certificate. It can be provided to a client", "example": "text" }, "amount_type": { "type": "string", "enum": [ "2", "1" ], "description": "The amount can be fixed or calculated by parameters; 2 - by amount of the last payment; 1 - fixed", "example": "" }, "amount": { "type": "string", "description": "Amount of funds that will be added to the account balance", "example": "text" }, "amount_percent": { "type": "string", "description": "Configuration of % from the amount of the previous payment", "example": "text" }, "amount_max": { "type": "string", "description": "The maximum amount that can be used when calculating by the last payment", "example": "text" }, "uselimit": { "type": "string", "description": "Certificate usage limit", "example": "1" }, "account_uselimit": { "type": "string", "description": "How many times a client can use this promo code ", "example": "1" }, "expire_period_specification": { "type": "string", "enum": [ "2", "1", "0" ], "description": "Configuration of the period when the funds can be used; 2 - till the specified date; 1 - during the specified period; 0 - unlimited", "example": "" }, "expire_date": { "type": "string", "description": "The funds can be used till this date (including)", "example": "text" }, "expire_period": { "type": "string", "description": "The funds can be used during the specified period", "example": "1" } } }, "PromotionCouponUsageElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "payment_number": { "type": "string", "description": "The number of the payment generated for the certificate " }, "usage_date": { "type": "string", "description": "The date and time when the certificate was used" }, "account_name": { "type": "string", "description": "The client who used the certificate" }, "payment_amount": { "type": "string", "description": "The amount of payment generated for the certificate" }, "status": { "type": "string", "description": "The status of the payment generated for the certificate" } } }, "PromotionDiscountHistoryElem": { "type": "object", "properties": {} }, "PromotionConditionHistoryElem": { "type": "object", "properties": {} }, "PromotionPromocodeHistoryElem": { "type": "object", "properties": {} }, "PromotionCouponHistoryElem": { "type": "object", "properties": {} }, "PromotionPromocodeUsageElem": { "type": "object", "properties": { "promocode": { "type": "string", "description": "Promo code has been already used " }, "id": { "type": "string", "description": "Service Id" }, "account_id": { "type": "string", "description": "Client code" }, "account": { "type": "string", "description": "Client who used this promo code " }, "status": { "type": "string", "description": "Service status" }, "expense": { "type": "string", "description": "Expenses " } } }, "CouponUsageElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "code": { "type": "string", "description": "Alphanumeric consequence of the certificate" }, "payment_number": { "type": "string", "description": "The number of the payment generated for the certificate " }, "usage_date": { "type": "string", "description": "The date and time when the certificate was used" }, "account_id": { "type": "string", "description": "Client code" }, "account_name": { "type": "string", "description": "The client who used the certificate" }, "payment_amount": { "type": "string", "description": "The amount of payment generated for the certificate" }, "status": { "type": "string", "description": "The status of the payment generated for the certificate" } } }, "CashbackUsageElem": { "type": "object", "properties": { "usage_date_tz": { "type": "string", "description": "Cashback registration date" }, "account_id": { "type": "string", "description": "Client code" }, "account_name": { "type": "string", "description": "Client name" }, "payment_source_number": { "type": "string", "description": "Original payment number" }, "payment_source_amount": { "type": "string", "description": "The amount of the original payment in the currency of the personal account" }, "payment_source_status": { "type": "string", "description": "Status of the original payment" }, "payment_cashback_number": { "type": "string", "description": "The number of payment, by which the cashback was credited" }, "payment_cashback_amount": { "type": "string", "description": "The amount of payment, by which the cashback was credited" }, "payment_cashback_status": { "type": "string", "description": "The status of payment by which the cashback was credited" } } }, "AdditionElem": { "type": "object", "properties": { "item": { "type": "string", "description": "The software license for which this module was bought" }, "id": { "type": "string", "description": "Id" }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "account": { "type": "string", "description": "Client who owns this service " }, "project": { "type": "string" }, "datacentername": { "type": "string", "description": "Data center where the service is located " }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "autoprolong": { "type": "string", "description": "Service auto renewal period. The service will be prolonged automatically on its expiration date " }, "status_msg": { "type": "string", "description": "Service current status " }, "item_status": { "type": "string", "description": "Service status " }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "processingmodule_failed": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "archived": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "Addition": { "type": "object", "properties": { "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "processingmodule": { "type": "string", "description": "Processing module", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "description": "Service will be deleted after paid period ", "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "description": "Reboot the server in the control panel ", "example": "off" }, "noexpense": { "type": "string", "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "" } } }, "BackupserviceElem": { "type": "object", "properties": { "accountname": { "type": "string", "description": "Name of account, provider's side" }, "id": { "type": "string", "description": "Id" }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "account": { "type": "string", "description": "Client who owns this service " }, "project": { "type": "string" }, "datacentername": { "type": "string", "description": "Data center where the service is located " }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "autoprolong": { "type": "string", "description": "Service auto renewal period. The service will be prolonged automatically on its expiration date " }, "status_msg": { "type": "string", "description": "Service current status " }, "item_status": { "type": "string", "description": "Service status " }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "processingmodule_failed": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "archived": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "Backupservice": { "type": "object", "properties": { "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "processingmodule": { "type": "string", "description": "Processing module", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "description": "Service will be deleted after paid period ", "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "description": "Reboot the server in the control panel ", "example": "off" }, "noexpense": { "type": "string", "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "" } } }, "CertificateElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Id" }, "CN": { "type": "string", "description": "Enter the domain name associated with the certificate" }, "account": { "type": "string", "description": "Client who owns this service " }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "project": { "type": "string" }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "subscriptiondate": { "type": "string", "description": "The certificate is valid for more than a year. You need to reinstall the certificate every time you change the certificate in the subscription." }, "status_msg": { "type": "string", "description": "Service current status " }, "item_status": { "type": "string", "description": "Service status " }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "Certificate": { "type": "object", "properties": { "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "text" }, "subscriptiondate": { "type": "string", "description": "The certificate is valid for more than a year. You need to reinstall the certificate every time you change the certificate in the subscription.", "example": "" }, "service_status": { "type": "string", "example": "" }, "custom_order_id": { "type": "string", "description": "Certificate identifier in the Certification authority ", "example": "" }, "approver_count": { "type": "string", "example": "" }, "noexpense": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "off" }, "crt_start_date": { "type": "string", "description": "Certificate activation date ", "example": "" }, "crt_end_date": { "type": "string", "description": "Certificate expiration date ", "example": "" }, "CN": { "type": "string", "description": "If you want to protect only one domain, enter www.example.com. If you want to protect domain and its subdomains, enter *.example.com. If you purchase multi-domain certificate, enter one domain www.example.com. Enter additional domains on the next order step", "example": "text" }, "field_country": { "type": "string", "description": "Select a country from the list", "example": "" }, "ST": { "type": "string", "description": "Enter the region. You can only use the Latin alphabet letters", "example": "text" }, "L": { "type": "string", "description": "Enter the city that will be shown in the certificate. You can use the Latin alphabet letters", "example": "text" }, "O": { "type": "string", "description": "Enter the organization name, or a full name of the individual this certificate will be issued for. Organization's legal status should be provided, if you are ordering EV certificates.You can use only the Latin alphabet letters ", "example": "text" }, "OU": { "type": "string", "description": "Enter the organization unit. You can use only the Latin alphabet letters", "example": "" }, "emailAddress": { "type": "string", "description": "Enter the email if you want it to show in the certificated details", "example": "example@domain.com" } } }, "CertificateReissue": { "type": "object", "properties": { "reissue_warn": { "type": "string", "description": "Warning:", "example": "" }, "reissue_desc": { "type": "string", "description": "You may need to re-issue your certificate in one of the following cases:<br/> - you lose your private key and need a new one<br/> - You need to add additional domain names to certificates supporting multiple domains ", "example": "" }, "crt_type": { "type": "string", "description": "You can enter either an existing CSR, or regenerate the certificate with old parameters specified below. You may find the secret key in the certificate edit form.", "example": "" }, "altname_input": { "type": "string", "description": "Values of domains/subdomains are entered with a space:\n <br/>- for a multidomain certificate, specify all domains that the certificate will protect (if protection with WWW and without WWW is required, specify both options);\n <br/>- for a non-multidomain certificate, specify all subdomains of the main domain that the certificate will protect.\n <br/>WWW, OWA, AUTODISCOVER and MAIL subdomains of the main domain may be provided free of charge depending on the certifiying authority.", "example": "" }, "altname_wildcard_input": { "type": "string", "description": "Enter all the Wildcard-domains separated by spaces that the multi-domain certificate will protect. To protect a domain with and without WWW, please enter 2 domains: with and without WWW.", "example": "" }, "CN": { "type": "string", "description": "If you want to protect only one domain, enter www.example.com. If you want to protect domain and its subdomains, enter *.example.com. If you purchase multi-domain certificate, enter one domain www.example.com. Enter additional domains on the next order step", "example": "text" }, "field_country": { "type": "string", "description": "Select a country from the list", "example": "" }, "ST": { "type": "string", "description": "Enter the region. You can only use the Latin alphabet letters", "example": "text" }, "L": { "type": "string", "description": "Enter the city that will be shown in the certificate. You can use the Latin alphabet letters", "example": "text" }, "O": { "type": "string", "description": "Enter the organization name, or a full name of the individual this certificate will be issued for. Organization's legal status should be provided, if you are ordering EV certificates.You can use only the Latin alphabet letters ", "example": "text" }, "OU": { "type": "string", "description": "Enter the organization unit. You can use only the Latin alphabet letters", "example": "" }, "emailAddress": { "type": "string", "description": "Enter the email if you want it to show in the certificated details", "example": "example@domain.com" }, "delete_private_key": { "type": "string", "enum": [ "on", "off" ], "description": "For security reasons you may not save the key in the billing system. If you lose your secret key, you will have to reissue the certificate", "example": "off" }, "hidden_field": { "type": "string", "example": "" }, "approver_method": { "type": "string", "enum": [ "auth_dnstxt", "auth_dnstxt", "auth_email", "auth_cname", "auth_file", "auth_dnstxt", "auth_dnstxt", "auth_email", "auth_cname", "auth_file" ], "description": "Certificate validation method; auth_dnstxt - By DNS TXT record; auth_dnstxt - By DNS TXT record; auth_email - Email validation; auth_cname - DNS-based validation; auth_file - Hash-file ; auth_dnstxt - By DNS TXT record; auth_dnstxt - By DNS TXT record; auth_email - Email validation; auth_cname - DNS-based validation; auth_file - Hash-file ", "example": "" }, "auth_file_protocol": { "type": "string", "description": "Check the box if your web-site can be accessed by HTTPS or leave the field blank ", "example": "" } } }, "CertificateDomainValidationRedirect": { "type": "object", "properties": {} }, "CertificateProlong": { "type": "object", "properties": { "approver_method": { "type": "string", "enum": [ "auth_dnstxt", "auth_dnstxt", "auth_email", "auth_cname", "auth_file", "auth_dnstxt", "auth_dnstxt", "auth_email", "auth_cname", "auth_file" ], "description": "Certificate validation method; auth_dnstxt - By DNS TXT record; auth_dnstxt - By DNS TXT record; auth_email - Email validation; auth_cname - DNS-based validation; auth_file - Hash-file ; auth_dnstxt - By DNS TXT record; auth_dnstxt - By DNS TXT record; auth_email - Email validation; auth_cname - DNS-based validation; auth_file - Hash-file ", "example": "" }, "auth_file_protocol": { "type": "string", "description": "Check the box if your web-site can be accessed by HTTPS or leave the field blank ", "example": "" } } }, "CertificateDnsVerify": { "type": "object", "properties": { "domains": { "type": "string", "description": "Select a domain for which the DNS record was added", "example": "" } } }, "CertificateDomainValidationEmail": { "type": "object", "properties": {} }, "CertificateFile": { "type": "object", "properties": { "info": { "type": "string", "description": "Enter new data and click \"OK\". Data will be verified and checked in the service properties form.<br/>If a client specifies a different certificate, he will receive an email with the certificate information ", "example": "" }, "CN": { "type": "string", "description": "If you want to protect only one domain, enter www.example.com. If you want to protect domain and its subdomains, enter *.example.com. If you purchase multi-domain certificate, enter one domain www.example.com. Enter additional domains on the next order step", "example": "text" }, "field_country": { "type": "string", "description": "Select a country from the list", "example": "" }, "ST": { "type": "string", "description": "Enter the region. You can only use the Latin alphabet letters", "example": "text" }, "L": { "type": "string", "description": "Enter the city that will be shown in the certificate. You can use the Latin alphabet letters", "example": "text" }, "O": { "type": "string", "description": "Enter the organization name, or a full name of the individual this certificate will be issued for. Organization's legal status should be provided, if you are ordering EV certificates.You can use only the Latin alphabet letters ", "example": "text" }, "OU": { "type": "string", "description": "Enter the organization unit. You can use only the Latin alphabet letters", "example": "" }, "emailAddress": { "type": "string", "description": "Enter the email if you want it to show in the certificated details", "example": "example@domain.com" }, "crt_start_date": { "type": "string", "description": "Certificate activation date ", "example": "" }, "crt_end_date": { "type": "string", "description": "Certificate expiration date ", "example": "" } } }, "ColocationElem": { "type": "object", "properties": { "panelid": { "type": "string", "description": "Identifier in the control panel " }, "racknumber": { "type": "string", "description": "The number of the rack where the server is installed " }, "label": { "type": "string", "description": "Server label " }, "id": { "type": "string", "description": "Id" }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "account": { "type": "string", "description": "Client who owns this service " }, "project": { "type": "string" }, "datacentername": { "type": "string", "description": "Data center where the service is located " }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "autoprolong": { "type": "string", "description": "Service auto renewal period. The service will be prolonged automatically on its expiration date " }, "status_msg": { "type": "string", "description": "Service current status " }, "item_status": { "type": "string", "description": "Service status " }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "processingmodule_failed": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "archived": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "Colocation": { "type": "object", "properties": { "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "processingmodule": { "type": "string", "description": "Processing module", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "description": "Service will be deleted after paid period ", "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "description": "Reboot the server in the control panel ", "example": "off" }, "noexpense": { "type": "string", "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "" } } }, "ColocationPortElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "linked_port": { "type": "string", "description": "Select a linked port " }, "vlan": { "type": "string", "description": "Name of the virtual network " } } }, "ColocationPortNew": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "1", "0" ], "description": "Select a connection type ; 1 - Connection to client's equipment ; 0 - Connect to provider's equipment ", "example": "" }, "linked_port": { "type": "string", "description": "Select a linked port ", "example": "" }, "vlan": { "type": "string", "description": "Name of the virtual network ", "example": "" } } }, "ColocationPort": { "type": "object", "properties": { "linked_port": { "type": "string", "description": "Select a linked port ", "example": "" }, "vlan": { "type": "string", "description": "Name of the virtual network ", "example": "" } } }, "ColocationHardwareElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "hardware": { "type": "string", "description": "Equipment description " }, "receivingdate": { "type": "string", "description": "Date when equipment was accepted by provider " }, "returndate": { "type": "string", "description": "Date when equipment was returned to client\n" }, "status": { "type": "string", "description": "Hardware status " } } }, "ColocationHardwareNew": { "type": "object", "properties": { "unit": { "type": "string", "description": "Colocation (rack and unit number)", "example": "text" }, "receiveemployee": { "type": "string", "description": "Full name of a staff member who accepted equipment ", "example": "text" }, "receiveuser": { "type": "string", "description": "Full name of the client who delivered equipment", "example": "text" }, "receivingdate": { "type": "string", "description": "Date when equipment was accepted by provider ", "example": "text" }, "returnemployee": { "type": "string", "description": "Full name of a staff member who delivered equipment ", "example": "text" }, "returnuser": { "type": "string", "description": "Full name of the client who accepted equipment", "example": "text" }, "returndate": { "type": "string", "description": "Date when equipment was returned to client\n", "example": "text" } } }, "ColocationHardware": { "type": "object", "properties": { "unit": { "type": "string", "description": "Colocation (rack and unit number)", "example": "text" }, "receiveemployee": { "type": "string", "description": "Full name of a staff member who accepted equipment ", "example": "text" }, "receiveuser": { "type": "string", "description": "Full name of the client who delivered equipment", "example": "text" }, "receivingdate": { "type": "string", "description": "Date when equipment was accepted by provider ", "example": "text" }, "returnemployee": { "type": "string", "description": "Full name of a staff member who delivered equipment ", "example": "text" }, "returnuser": { "type": "string", "description": "Full name of the client who accepted equipment", "example": "text" }, "returndate": { "type": "string", "description": "Date when equipment was returned to client\n", "example": "text" } } }, "ColocationHardwareReturn": { "type": "object", "properties": { "returnemployee": { "type": "string", "description": "Full name of a staff member who delivered equipment to client", "example": "text" }, "returnuser": { "type": "string", "description": "Full name of a staff member who accepted equipment", "example": "text" }, "returndate": { "type": "string", "description": "Date when equipment was returned to client\n", "example": "text" } } }, "DedicElem": { "type": "object", "properties": { "domain": { "type": "string", "description": "Service domain name " }, "ip": { "type": "string", "description": "IP addresses" }, "ostempl": { "type": "string", "description": "Name of the operating system template " }, "panelid": { "type": "string", "description": "Identifier in the control panel " }, "racknumber": { "type": "string", "description": "The number of the rack where the server is installed " }, "label": { "type": "string", "description": "Server label " }, "id": { "type": "string", "description": "Id" }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "account": { "type": "string", "description": "Client who owns this service " }, "project": { "type": "string" }, "datacentername": { "type": "string", "description": "Data center where the service is located " }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "autoprolong": { "type": "string", "description": "Service auto renewal period. The service will be prolonged automatically on its expiration date " }, "status_msg": { "type": "string", "description": "Service current status " }, "item_status": { "type": "string", "description": "Service status " }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "processingmodule_failed": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "archived": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "Dedic": { "type": "object", "properties": { "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "processingmodule": { "type": "string", "description": "Processing module", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "description": "Service will be deleted after paid period ", "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "description": "Reboot the server in the control panel ", "example": "off" }, "noexpense": { "type": "string", "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "" } } }, "DnshostElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Id" }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "account": { "type": "string", "description": "Client who owns this service " }, "project": { "type": "string" }, "datacentername": { "type": "string", "description": "Data center where the service is located " }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "autoprolong": { "type": "string", "description": "Service auto renewal period. The service will be prolonged automatically on its expiration date " }, "status_msg": { "type": "string", "description": "Service current status " }, "item_status": { "type": "string", "description": "Service status " }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "processingmodule_failed": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "archived": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "Dnshost": { "type": "object", "properties": { "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "processingmodule": { "type": "string", "description": "Processing module", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "description": "Service will be deleted after paid period ", "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "description": "Reboot the server in the control panel ", "example": "off" }, "noexpense": { "type": "string", "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "" } } }, "DomainElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Id" }, "domain": { "type": "string", "description": "Enter a domain name including the top-level zone " }, "account": { "type": "string", "description": "Client who owns this service " }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "project": { "type": "string" }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "status_msg": { "type": "string", "description": "Service current status " }, "item_status": { "type": "string", "description": "Service status " }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "Domain": { "type": "object", "properties": { "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "processingmodule": { "type": "string", "description": "Processing module", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "description": "Service will be deleted after paid period ", "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "description": "Reboot the server in the control panel ", "example": "off" }, "noexpense": { "type": "string", "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "" } } }, "DomainWhois": { "type": "object", "properties": {} }, "DomainNs": { "type": "object", "properties": { "ns0": { "type": "string", "description": "Use the following record format: \"ns.example.com\" or \"ns.example.com/1.1.1.1\" or \"ns.example.com/1.1.1.1,2.2.2.2\"", "example": "" }, "ns1": { "type": "string", "description": "Use the following record format: \"ns.example.com\" or \"ns.example.com/1.1.1.1\" or \"ns.example.com/1.1.1.1,2.2.2.2\"", "example": "" }, "ns2": { "type": "string", "description": "Use the following record format: \"ns.example.com\" or \"ns.example.com/1.1.1.1\" or \"ns.example.com/1.1.1.1,2.2.2.2\"", "example": "" }, "ns3": { "type": "string", "description": "Use the following record format: \"ns.example.com\" or \"ns.example.com/1.1.1.1\" or \"ns.example.com/1.1.1.1,2.2.2.2\"", "example": "" }, "ns_additional": { "type": "string", "description": "Use the following record format: \"ns.example.com\" or \"ns.example.com/1.1.1.1\" or \"ns.example.com/1.1.1.1,2.2.2.2\". Each additional domain is added with a new line", "example": "" }, "provider": { "type": "string", "example": "" } } }, "DomainDocElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "profile": { "type": "string", "description": "Contact for which this document is uploaded " }, "doctype": { "type": "string", "description": "Document type " }, "name": { "type": "string", "description": "File name" }, "size": { "type": "string", "description": "File size " }, "props": { "type": "string", "description": "Document status " } } }, "DomainDocUpload": { "type": "object", "properties": { "doctype": { "type": "string", "description": "Document type ", "example": "" }, "file": { "type": "string", "description": "Local file ", "example": "" } } }, "DomainDoc": { "type": "object", "properties": { "doctype": { "type": "string", "description": "Document type ", "example": "" } } }, "PaidsupportElem": { "type": "object", "properties": { "ticket_usage": { "type": "string", "description": "Number of support incidents that were deducted from the client's account during this month" }, "id": { "type": "string", "description": "Id" }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "account": { "type": "string", "description": "Client who owns this service " }, "project": { "type": "string" }, "datacentername": { "type": "string", "description": "Data center where the service is located " }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "autoprolong": { "type": "string", "description": "Service auto renewal period. The service will be prolonged automatically on its expiration date " }, "status_msg": { "type": "string", "description": "Service current status " }, "item_status": { "type": "string", "description": "Service status " }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "processingmodule_failed": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "archived": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "Paidsupport": { "type": "object", "properties": { "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "processingmodule": { "type": "string", "description": "Processing module", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "description": "Service will be deleted after paid period ", "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "description": "Reboot the server in the control panel ", "example": "off" }, "noexpense": { "type": "string", "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "" } } }, "PaidsupportProlong": { "type": "object", "properties": {} }, "SoftElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Id" }, "licname": { "type": "string", "description": "License name" }, "ip": { "type": "string", "description": "IP addresses" }, "period": { "type": "string", "description": "Period" }, "update_expiredate": { "type": "string", "description": "Updates expiration date" }, "real_ipchange": { "type": "string", "description": "Date of last change or IP address specification " }, "real_keychange": { "type": "string", "description": "Date of license key generation " }, "comment": { "type": "string", "description": "Comment to license" }, "used_stat": { "type": "string", "description": "Resources usage statistics by the license in the form: <br><i>in use/available (available after renewal)</i><br><br> The field<i>available after renewal</i> is use with the policy <i>Change during renewal</i> and will be missing if the client has not changed the resources" }, "closed_loop": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"License for closed loop\"" }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "account": { "type": "string", "description": "Client who owns this service " }, "project": { "type": "string" }, "datacentername": { "type": "string", "description": "Data center where the service is located " }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "autoprolong": { "type": "string", "description": "Service auto renewal period. The service will be prolonged automatically on its expiration date " }, "status_msg": { "type": "string", "description": "Service current status " }, "item_status": { "type": "string", "description": "Service status " }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "processingmodule_failed": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "archived": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "Soft": { "type": "object", "properties": { "is_platform": { "type": "string", "example": "" }, "is_closed_loop": { "type": "string", "example": "" }, "remoteip": { "type": "string", "description": "Enter a license IP address. Leave the field blank if it matches the IP to which the license will be assigned", "example": "" }, "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "processingmodule": { "type": "string", "description": "Processing module", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "description": "Service will be deleted after paid period ", "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "description": "Reboot the server in the control panel ", "example": "off" }, "noexpense": { "type": "string", "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "" } } }, "SoftProlongUpdate": { "type": "object", "properties": { "period": { "type": "string", "description": "Select a renewal period", "example": "" } } }, "SoftexternalElem": { "type": "object", "properties": { "licname": { "type": "string", "description": "This name enables you to easily identify a license " }, "ip": { "type": "string", "description": "IP addresses" }, "id": { "type": "string", "description": "Id" }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "account": { "type": "string", "description": "Client who owns this service " }, "project": { "type": "string" }, "datacentername": { "type": "string", "description": "Data center where the service is located " }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "autoprolong": { "type": "string", "description": "Service auto renewal period. The service will be prolonged automatically on its expiration date " }, "status_msg": { "type": "string", "description": "Service current status " }, "item_status": { "type": "string", "description": "Service status " }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "processingmodule_failed": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "archived": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "Softexternal": { "type": "object", "properties": { "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "processingmodule": { "type": "string", "description": "Processing module", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "description": "Service will be deleted after paid period ", "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "description": "Reboot the server in the control panel ", "example": "off" }, "noexpense": { "type": "string", "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "" } } }, "StorageElem": { "type": "object", "properties": { "addr": { "type": "string", "description": "Enter the IP address of the FTP-server" }, "processingnode": { "type": "string" }, "user": { "type": "string" }, "quota": { "type": "string", "description": "Enter disk space in MiB occupied by user files (in use/ total) " }, "id": { "type": "string", "description": "Id" }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "account": { "type": "string", "description": "Client who owns this service " }, "project": { "type": "string" }, "datacentername": { "type": "string", "description": "Data center where the service is located " }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "autoprolong": { "type": "string", "description": "Service auto renewal period. The service will be prolonged automatically on its expiration date " }, "status_msg": { "type": "string", "description": "Service current status " }, "item_status": { "type": "string", "description": "Service status " }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "processingmodule_failed": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "archived": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "Storage": { "type": "object", "properties": { "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "processingmodule": { "type": "string", "description": "Processing module", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "description": "Service will be deleted after paid period ", "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "description": "Reboot the server in the control panel ", "example": "off" }, "noexpense": { "type": "string", "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "" } } }, "VdcElem": { "type": "object", "properties": { "vdcname": { "type": "string" }, "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "pricelist": { "type": "string" }, "account": { "type": "string" }, "project": { "type": "string" }, "datacentername": { "type": "string" }, "processingmodule": { "type": "string" }, "createdate": { "type": "string" }, "expiredate": { "type": "string" }, "autoprolong": { "type": "string" }, "status_msg": { "type": "string" }, "item_status": { "type": "string" }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "processingmodule_failed": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "archived": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Total monthly cost including all service add-ons and discounts" } } }, "Vdc": { "type": "object", "properties": { "autoprolong": { "type": "string", "example": "" }, "stored_method": { "type": "string", "example": "" }, "stored_method_warning": { "type": "string", "example": "" }, "processingmodule": { "type": "string", "example": "" }, "createdate": { "type": "string", "example": "" }, "opendate": { "type": "string", "example": "" }, "expiredate": { "type": "string", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "example": "off" }, "noexpense": { "type": "string", "example": "" } } }, "VdcVmElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "is_backup": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Virtual server backup process is set up\"" }, "vm_group": { "type": "string", "description": "Group of virtual servers " }, "vmtempl": { "type": "string", "description": "Virtual server parameter template" }, "ostempl_name": { "type": "string", "description": "OS template installed on virtual server" }, "external_ip": { "type": "string", "description": "Dedicated IP addresses added to virtual server" }, "internal_ip": { "type": "string", "description": "IP addresses of virtual server connections to virtual data center networks" }, "ncpu_m": { "type": "string", "description": "Number of CPU for virtual server" }, "availability_zone": { "type": "string", "description": "Hypervisor group" }, "mem_m": { "type": "string", "description": "RAM given to virtual server" }, "disc_total_m": { "type": "string", "description": "Total volume of hard drives of virtual server" }, "status": { "type": "string" } } }, "VdcVmNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of virtual server", "example": "text" }, "vmtempl": { "type": "string", "description": "Virtual server template", "example": "" }, "source": { "type": "string", "enum": [ "vdc_volume", "vdc_volume_snapshot", "vdc_vm_snapshote", "ostempl" ], "description": "Select the base object that will be used to create a new virtual server; vdc_volume - Available disk; vdc_volume_snapshot - Disk snapshot; vdc_vm_snapshote - Snapshot of virtual server; ostempl - Operating system template", "example": "" }, "ostempl": { "type": "string", "description": "OS template used to create a new virtual server", "example": "" }, "vdc_volume": { "type": "string", "enum": [ "snapshot" ], "description": "You can only select a bootable disk that is not used by any virtual server; snapshot - Disk snapshot", "example": "" }, "vdc_volume_snapshot": { "type": "string", "description": "New disk for the virtual server will be created based on the snapshot", "example": "" }, "vdc_vm_snapshot": { "type": "string", "description": "New virtual server will be created on the basis of snapshot", "example": "" }, "vdc_vm_group": { "type": "string", "description": "Group for virtual server", "example": "" }, "vm_group_name": { "type": "string", "description": "Name of virtual server group", "example": "text" }, "vdc_network": { "type": "string", "description": "Virtual data center network which the new virtual server will be connected to", "example": "" }, "create_volume": { "type": "string", "enum": [ "on", "off" ], "description": "Disk of the specified volume will be created for virtual server", "example": "off" }, "disc": { "type": "string", "description": "Disk volume of virtua server", "example": "1" }, "enable_cpuoverselling": { "type": "string", "enum": [ "on", "off" ], "description": "Use oversold cores instead of normal ones", "example": "off" }, "ncpu": { "type": "string", "description": "CPU number of virtual server", "example": "1" }, "ncpuoverselling": { "type": "string", "description": "Number of virtual server CPU (core overselling)", "example": "1" }, "mem": { "type": "string", "description": "RAM given to virtual server", "example": "1" }, "password": { "type": "string", "description": "Virtual server password", "example": "" }, "confirm": { "type": "string", "example": "" } } }, "VdcVm": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of virtual server", "example": "text" }, "vmtempl": { "type": "string", "description": "Virtual server template", "example": "" }, "enable_cpuoverselling": { "type": "string", "enum": [ "on", "off" ], "description": "Use oversold cores instead of normal ones", "example": "off" }, "ncpu": { "type": "string", "description": "CPU number of virtual server", "example": "1" }, "ncpuoverselling": { "type": "string", "description": "Number of virtual server CPU (core overselling)", "example": "1" }, "mem": { "type": "string", "description": "RAM given to virtual server", "example": "1" }, "password": { "type": "string", "description": "Virtual server password", "example": "" } } }, "VdcVmNetworkElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "network_name": { "type": "string", "description": "Enter the name of the VDC network that the virtual server will be connected to " }, "primary_connection": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Primary network connection \"" }, "ip_address": { "type": "string", "description": "Connection IP address " }, "network_subnet": { "type": "string", "description": "Select the subnet the virtual server is connected to " }, "mac": { "type": "string", "description": "MAC-address of the connection port " } } }, "VdcVmNetworkNew": { "type": "object", "properties": { "network": { "type": "string", "description": "Enter the VDC network the virtual server will be connected to ", "example": "" } } }, "VdcVmVolumeElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Disk name " }, "size": { "type": "string", "description": "Disk size in GB " } } }, "VdcVmVolumeNew": { "type": "object", "properties": { "volumelist": { "type": "string", "description": "Name of the disk you want to connect to virtual server ", "example": "" } } }, "VdcVmIpElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "ip": { "type": "string" }, "status": { "type": "string" } } }, "VdcVmIpNew": { "type": "object", "properties": { "iplist": { "type": "string", "description": "Enter the IP address you want to connected to the virtual server ", "example": "" }, "port": { "type": "string", "description": "Enter the port of the server that the external IP address will be connected to ", "example": "" } } }, "VdcNetworkElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "vm_group": { "type": "string" }, "router": { "type": "string", "description": "The router the network is connected to " }, "gateway": { "type": "string", "description": "Select a network gateway " }, "mask": { "type": "string", "description": "Network mask " }, "network_subnets": { "type": "string", "description": "Subnet addresses " }, "network_pools": { "type": "string", "description": "A pool of network IP addresses in the form of an IP address or a range: first_IP-address-last_IP-address. For example: 192.168.0.100, 192.168.0.2-192.168.0.100" }, "status": { "type": "string" } } }, "VdcNetworkNew": { "type": "object", "properties": { "name": { "type": "string", "example": "text" }, "vdc_vm_group": { "type": "string", "description": "Allows to create the network which would be available inside the group of virtual servers only", "example": "" }, "create_subnet": { "type": "string", "enum": [ "on", "off" ], "description": "Enables to create subnet during network creation ", "example": "off" }, "subnet_name": { "type": "string", "description": "Subnet name ", "example": "text" }, "subnet_type": { "type": "string", "description": "Select the network address ", "example": "" }, "subnet_pool": { "type": "string", "description": "Select the network address from the pool ", "example": "" }, "subnet_mask": { "type": "string", "description": "Subnet mask", "example": "" }, "subnet_cidr": { "type": "string", "description": "Subnet address in the form 'network_address/network_mask'. For example: 192.168.0.0/24", "example": "text" }, "subnet_use_gateway": { "type": "string", "enum": [ "on", "off" ], "description": "Use gateway for this subnet. One of the subnet addresses will be used by the gateway ", "example": "off" }, "subnet_gateway": { "type": "string", "description": "Gateway address which is used in subnet. Leave the field blank to allocate IP automatically ", "example": "" }, "subnet_use_dhcp": { "type": "string", "enum": [ "on", "off" ], "description": "Use DHCP for this subnet. One of the subnet address will be used by DHCP ", "example": "off" }, "gateway": { "type": "string", "description": "Gateway ", "example": "text" }, "mask": { "type": "string", "description": "Network mask ", "example": "text" }, "dns1": { "type": "string", "description": "Primary DNS server which is used in network", "example": "" }, "dns2": { "type": "string", "description": "Secondary DNS server which is used in network", "example": "" }, "dns_suffix": { "type": "string", "description": "DNS suffix which is used in network", "example": "" }, "subnet_vdc_router": { "type": "string", "example": "" }, "vdc_router": { "type": "string", "description": "The newly created network will be connected to the selected router of the virtual data-center", "example": "" }, "vdc_network": { "type": "string", "description": "Network will be connceted to the selected network of virtual Data Center", "example": "" }, "network_pools": { "type": "string", "example": "" }, "network_dhcp": { "type": "string", "example": "" } } }, "VdcNetwork": { "type": "object", "properties": { "name": { "type": "string", "example": "text" }, "gateway": { "type": "string", "description": "Gateway ", "example": "text" }, "mask": { "type": "string", "description": "Network mask ", "example": "text" }, "dns1": { "type": "string", "description": "Primary DNS server which is used in network", "example": "" }, "dns2": { "type": "string", "description": "Secondary DNS server which is used in network", "example": "" }, "dns_suffix": { "type": "string", "description": "DNS suffix which is used in network", "example": "" }, "vdc_network": { "type": "string", "description": "Network will be connceted to the selected network of virtual Data Center", "example": "" }, "network_pools": { "type": "string", "example": "" }, "network_dhcp": { "type": "string", "example": "" } } }, "VdcNetworkSubnetElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "cidr": { "type": "string", "description": "Subnet address " }, "gateway": { "type": "string", "description": "Gateway address which is used in subnet " }, "status": { "type": "string" }, "use_gateway": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Gateway is use \"" }, "use_dhcp": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"off\": \"DHCP is disabled \"" } } }, "VdcNetworkSubnetNew": { "type": "object", "properties": { "name": { "type": "string", "example": "text" }, "subnet_type": { "type": "string", "description": "Select the address network interface ", "example": "" }, "pool": { "type": "string", "description": "Select the network address from the pool ", "example": "" }, "mask": { "type": "string", "description": "Subnet mask", "example": "" }, "cidr": { "type": "string", "description": "Subnet address ", "example": "text" }, "use_gateway": { "type": "string", "enum": [ "on", "off" ], "description": "Use gateway for this subnet. One of the subnet addresses will be used by the gateway ", "example": "off" }, "gateway": { "type": "string", "description": "Gateway address which is used for subnet. Leave the field blank if you wan to allocate IP automatically ", "example": "text" }, "use_dhcp": { "type": "string", "enum": [ "on", "off" ], "description": "Use DHCP for this subnet. One of the subnet address will be used by DHCP ", "example": "off" } } }, "VdcNetworkSubnet": { "type": "object", "properties": { "name": { "type": "string", "example": "text" }, "cidr": { "type": "string", "description": "Subnet address ", "example": "text" }, "use_gateway": { "type": "string", "enum": [ "on", "off" ], "description": "Use gateway for this subnet. One of the subnet addresses will be used by the gateway ", "example": "off" }, "gateway": { "type": "string", "description": "Gateway address which is used for subnet. Leave the field blank if you wan to allocate IP automatically ", "example": "text" }, "use_dhcp": { "type": "string", "enum": [ "on", "off" ], "description": "Use DHCP for this subnet. One of the subnet address will be used by DHCP ", "example": "off" } } }, "VdcVolumeElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Disk name " }, "size": { "type": "string", "description": "Disk size in GB " }, "externalid": { "type": "string", "description": "Disk ID" }, "vdc_vm_name": { "type": "string", "description": "Virtual server the disk is connected to" }, "type": { "type": "string", "description": "Disk type" }, "bootable": { "type": "string", "description": "Boot disk " }, "ss": { "type": "string", "description": "Disk has snapshots " }, "status": { "type": "string" } } }, "VdcVolumeNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Disk name ", "example": "" }, "type": { "type": "string", "description": "Disk type", "example": "" }, "source_type": { "type": "string", "description": "Disk creation source ", "example": "" }, "ostempl": { "type": "string", "description": "Select the image that will be used for disk creation ", "example": "" }, "snapshot": { "type": "string", "description": "Select the snapshot that will be used for disk creation ", "example": "" }, "size": { "type": "string", "description": "Disk size in GB ", "example": "1" } } }, "VdcVolume": { "type": "object", "properties": { "name": { "type": "string", "description": "Disk name ", "example": "" }, "bootable": { "type": "string", "enum": [ "on", "off" ], "description": "Boot disk ", "example": "off" } } }, "VdcVolumeSnapshotElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Name" }, "externalid": { "type": "string", "description": "Snapshot ID " }, "vdc_volume": { "type": "string", "description": "Disk that the snapshot is associated with " }, "status": { "type": "string" } } }, "VdcVolumeSnapshotNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Name", "example": "text" } } }, "VdcVolumeSnapshot": { "type": "object", "properties": { "name": { "type": "string", "description": "Name", "example": "text" } } }, "VdcRouterElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "externalid": { "type": "string", "description": "Router identifier in the control panel " }, "name": { "type": "string", "description": "Name " }, "routertempl_name": { "type": "string", "description": "Router configuration" }, "network": { "type": "string", "description": "External network " }, "external_ip": { "type": "string", "description": "the external IP-addresses of router" }, "status": { "type": "string" }, "use_dhcp": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"off\": \"DHCP is disabled \"" }, "use_firewall": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"off\": \"Firewall is switched off\"" }, "use_vpn": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"VPN is switched on\"" } } }, "VdcRouterNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Name ", "example": "text" }, "routertempl": { "type": "string", "description": "Router configuration ", "example": "" }, "external_network": { "type": "string", "description": "External network that the router will be connected to ", "example": "" }, "use_dhcp": { "type": "string", "enum": [ "on", "off" ], "description": "Enable DHCP for router", "example": "off" }, "use_firewall": { "type": "string", "enum": [ "on", "off" ], "description": "Enable Firewall for router ", "example": "off" }, "firewall_policy": { "type": "string", "description": "Default policy for packages ", "example": "" }, "use_vpn": { "type": "string", "enum": [ "on", "off" ], "description": "Enable VPN for router ", "example": "off" } } }, "VdcRouter": { "type": "object", "properties": { "name": { "type": "string", "description": "Name ", "example": "text" }, "routertempl": { "type": "string", "description": "Router configuration ", "example": "" }, "external_network": { "type": "string", "description": "External network that the router will be connected to ", "example": "" }, "use_dhcp": { "type": "string", "enum": [ "on", "off" ], "description": "Enable DHCP for router", "example": "off" }, "use_firewall": { "type": "string", "enum": [ "on", "off" ], "description": "Enable Firewall for router ", "example": "off" }, "firewall_policy": { "type": "string", "description": "Default policy for packages ", "example": "" }, "use_vpn": { "type": "string", "enum": [ "on", "off" ], "description": "Enable VPN for router ", "example": "off" } } }, "VdcRouterInterfaceElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "externalid": { "type": "string", "description": "Router interface id in OpenStack" }, "network": { "type": "string", "description": "Network" }, "subnet": { "type": "string", "description": "Subnet " }, "fixedips": { "type": "string", "description": "IP address " }, "type": { "type": "string", "description": "Interface type\n" }, "status": { "type": "string" } } }, "VdcRouterInterfaceNew": { "type": "object", "properties": { "subnet": { "type": "string", "description": "Subnet that the router will be associated with ", "example": "" } } }, "VdcRouterInterfaceParam": { "type": "object", "properties": {} }, "VdcRouterDhcpElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "network": { "type": "string", "description": "Data-center network " }, "ip_range": { "type": "string", "description": "Select a range that IP addresses will be allocated from " }, "default_lease_time": { "type": "string", "description": "Enter the default time for IP address lease " }, "max_lease_time": { "type": "string", "description": "Enter the maximum lease time for the IP address " }, "status": { "type": "string" } } }, "VdcRouterDhcpNew": { "type": "object", "properties": { "vdc_network": { "type": "string", "description": "Select a data-center the DHCP range is activated for ", "example": "" }, "ip_range": { "type": "string", "description": "Select a range that IP addresses will be allocated from ", "example": "text" }, "default_lease_time": { "type": "string", "description": "Enter the default time for IP address lease ", "example": "1" }, "max_lease_time": { "type": "string", "description": "Enter the maximum lease time for the IP address ", "example": "60" } } }, "VdcRouterDhcp": { "type": "object", "properties": { "ip_range": { "type": "string", "description": "Select a range that IP addresses will be allocated from ", "example": "text" }, "default_lease_time": { "type": "string", "description": "Enter the default time for IP address lease ", "example": "1" }, "max_lease_time": { "type": "string", "description": "Enter the maximum lease time for the IP address ", "example": "60" } } }, "VdcRouterNatElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "network": { "type": "string", "description": "Data-center network " }, "rule_type": { "type": "string", "description": "Address translation type. SNAT - translates outgoing requests going from the internal network, DNAT - translates incoming requests going to the internal network " }, "original_ip_range": { "type": "string", "description": "For the SNAT rule enter an internal IP-address or IP range, for DNAT - an external IP-address or IP range. You can enter a specific value or select it from the list" }, "original_port_desc": { "type": "string", "description": "Select a source port " }, "translated_ip_range": { "type": "string", "description": "For the SNAT rule enter an external IP-address or IP range, for DNAT - an internal IP-address or IP range. You can enter a specific value or select it from the list " }, "translated_port_desc": { "type": "string", "description": "Select the translated port " }, "protocol": { "type": "string", "description": "Select the protocol the NAT rule will be applied to " }, "status": { "type": "string" } } }, "VdcRouterNatNew": { "type": "object", "properties": { "vdc_network": { "type": "string", "description": "Select data-center network the NAT rule will be applied to ", "example": "" }, "rule_type": { "type": "string", "enum": [ "2", "1", "2", "1" ], "description": "Address translation type. SNAT - translates outgoing requests going from the internal network, DNAT - translates incoming requests going to the internal network ; 2 - DNAT; 1 - SNAT; 2 - DNAT; 1 - SNAT", "example": "" }, "protocol": { "type": "string", "enum": [ "icmp", "tcp", "tcp_udp", "any", "udp", "icmp", "tcp", "tcp_udp", "any", "udp" ], "description": "Select the protocol the NAT rule will be applied to ; icmp - ICMP; tcp - TCP; tcp_udp - TCP and UDP; any - any; udp - UDP; icmp - ICMP; tcp - TCP; tcp_udp - TCP and UDP; any - any; udp - UDP", "example": "" }, "original_ip_range": { "type": "string", "description": "For the SNAT rule enter an internal IP-address or IP range, for DNAT - an external IP-address or IP range. You can enter a specific value or select it from the list", "example": "" }, "original_port": { "type": "string", "description": "Source port. You can enter a specific value or select it from the list ", "example": "" }, "translated_ip_range": { "type": "string", "description": "For the SNAT rule enter an external IP-address or IP range, for DNAT - an internal IP-address or IP range. You can enter a specific value or select it from the list ", "example": "" }, "translated_port": { "type": "string", "description": "The translated port. You can enter a certain value or select it from the list", "example": "" } } }, "VdcRouterNat": { "type": "object", "properties": { "vdc_network": { "type": "string", "description": "Select data-center network the NAT rule will be applied to ", "example": "" }, "rule_type": { "type": "string", "enum": [ "2", "1", "2", "1" ], "description": "Address translation type. SNAT - translates outgoing requests going from the internal network, DNAT - translates incoming requests going to the internal network ; 2 - DNAT; 1 - SNAT; 2 - DNAT; 1 - SNAT", "example": "" }, "protocol": { "type": "string", "enum": [ "icmp", "tcp", "tcp_udp", "any", "udp", "icmp", "tcp", "tcp_udp", "any", "udp" ], "description": "Select the protocol the NAT rule will be applied to ; icmp - ICMP; tcp - TCP; tcp_udp - TCP and UDP; any - any; udp - UDP; icmp - ICMP; tcp - TCP; tcp_udp - TCP and UDP; any - any; udp - UDP", "example": "" }, "original_ip_range": { "type": "string", "description": "For the SNAT rule enter an internal IP-address or IP range, for DNAT - an external IP-address or IP range. You can enter a specific value or select it from the list", "example": "" }, "original_port": { "type": "string", "description": "Source port. You can enter a specific value or select it from the list ", "example": "" }, "translated_ip_range": { "type": "string", "description": "For the SNAT rule enter an external IP-address or IP range, for DNAT - an internal IP-address or IP range. You can enter a specific value or select it from the list ", "example": "" }, "translated_port": { "type": "string", "description": "The translated port. You can enter a certain value or select it from the list", "example": "" } } }, "VdcRouterFirewallElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Rule name " }, "source_desc": { "type": "string", "description": "Select a source " }, "destination_desc": { "type": "string", "description": "Select the traffic destination IP" }, "protocol": { "type": "string", "description": "Select a protocol the rule will be applied to " }, "policy": { "type": "string", "description": "Set traffic policy " }, "status": { "type": "string" }, "use_log": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Traffic logging is activated \"" } } }, "VdcRouterFirewallNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Rule name ", "example": "text" }, "protocol": { "type": "string", "enum": [ "icmp", "tcp", "tcp_udp", "any", "udp", "icmp", "tcp", "tcp_udp", "any", "udp" ], "description": "Select a protocol the rule will be applied to ; icmp - ICMP; tcp - TCP; tcp_udp - TCP and UDP; any - any; udp - UDP; icmp - ICMP; tcp - TCP; tcp_udp - TCP and UDP; any - any; udp - UDP", "example": "" }, "source": { "type": "string", "enum": [ "port" ], "description": "Traffic source. Possible values: IP address, CIDR, range of IP addresses, \"any\",\"internal\" and \"external\". You can enter a specific value or select it from the list; port - Source port ", "example": "" }, "source_port": { "type": "string", "description": "Source port. You can enter a specific value or select it from the list", "example": "" }, "destination": { "type": "string", "enum": [ "port" ], "description": "Traffic destination IP. Possible values: IP address, CIDR, a range of IP addresses, \"any\",\"internal\" and \"external\". You can enter a specific value or select it from the list; port - Destination IP port ", "example": "" }, "destination_port": { "type": "string", "description": "Destination IP port. You can enter a specific value or select it from the list ", "example": "" }, "policy": { "type": "string", "enum": [ "allow", "deny", "allow", "deny" ], "description": "Set traffic policy ; allow - Allowed; deny - Forbidden; allow - Allowed; deny - Forbidden", "example": "" }, "use_log": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to log traffic associated with the rule ", "example": "off" } } }, "VdcRouterFirewall": { "type": "object", "properties": { "name": { "type": "string", "description": "Rule name ", "example": "text" }, "protocol": { "type": "string", "enum": [ "icmp", "tcp", "tcp_udp", "any", "udp", "icmp", "tcp", "tcp_udp", "any", "udp" ], "description": "Select a protocol the rule will be applied to ; icmp - ICMP; tcp - TCP; tcp_udp - TCP and UDP; any - any; udp - UDP; icmp - ICMP; tcp - TCP; tcp_udp - TCP and UDP; any - any; udp - UDP", "example": "" }, "source": { "type": "string", "enum": [ "port" ], "description": "Traffic source. Possible values: IP address, CIDR, range of IP addresses, \"any\",\"internal\" and \"external\". You can enter a specific value or select it from the list; port - Source port ", "example": "" }, "source_port": { "type": "string", "description": "Source port. You can enter a specific value or select it from the list", "example": "" }, "destination": { "type": "string", "enum": [ "port" ], "description": "Traffic destination IP. Possible values: IP address, CIDR, a range of IP addresses, \"any\",\"internal\" and \"external\". You can enter a specific value or select it from the list; port - Destination IP port ", "example": "" }, "destination_port": { "type": "string", "description": "Destination IP port. You can enter a specific value or select it from the list ", "example": "" }, "policy": { "type": "string", "enum": [ "allow", "deny", "allow", "deny" ], "description": "Set traffic policy ; allow - Allowed; deny - Forbidden; allow - Allowed; deny - Forbidden", "example": "" }, "use_log": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to log traffic associated with the rule ", "example": "off" } } }, "VdcRouterVpnElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Tunnel name " }, "connection_type": { "type": "string", "description": "Select a connection method of the IPSec VPN tunnel " }, "local_ip_address": { "type": "string", "description": "IP address of the local connection point " }, "peer_ip_address": { "type": "string", "description": "Address of the external connection point " }, "network_local": { "type": "string", "description": "Addresses of the local networks " }, "network_peer": { "type": "string", "description": "Addresses of the external networks " }, "encryption_protocol": { "type": "string", "description": "Connection encryption protocol " }, "status": { "type": "string" } } }, "VdcRouterVpnNew": { "type": "object", "properties": { "name": { "type": "string", "example": "text" }, "connection_type": { "type": "string", "enum": [ "2", "1", "3" ], "description": "Select a connection method of the IPSec VPN tunnel ; 2 - External organization network ; 1 - Organization network ; 3 - External network ", "example": "" }, "vdc_router_peer": { "type": "string", "description": "Select a router of the virtual data-center that the IPSec VPN tunnel will be configured ", "example": "" }, "vdc_network_local": { "type": "string", "description": "Local networks connected to the router ", "example": "" }, "vdc_network_peer": { "type": "string", "description": "External networks connected to the router of the virtual data-center ", "example": "" }, "peer_cidr": { "type": "string", "description": "External networks that the IPSec VPN tunnel is configured for. Supported format: address_network/mask, space separated. For example: 192.168.0.0/24 192.168.1.0/24", "example": "text" }, "local_endpoint": { "type": "string", "enum": [ "use_public_ip_msg" ], "description": "Router interface that will be used for VPN connection. Select the \"Public IP address\" check box if you want to use public IP address for connection; use_public_ip_msg - Public IP address ", "example": "" }, "local_endpoint_use_public_ip": { "type": "string", "enum": [ "on", "off" ], "example": "off" }, "peer_endpoint": { "type": "string", "enum": [ "use_public_ip_msg" ], "description": "Router interface that will be used for VPN connection. Select the \"Public IP address\" check box if you want to use public IP address for connection ; use_public_ip_msg - Public IP address ", "example": "" }, "peer_endpoint_use_public_ip": { "type": "string", "enum": [ "on", "off" ], "example": "off" }, "local_id": { "type": "string", "description": "Local ID IPSec VPN tunnel ", "example": "text" }, "peer_id": { "type": "string", "description": "External ID IPSec VPN tunnel ", "example": "text" }, "peer_ip_address": { "type": "string", "description": "Address of the external connection point ", "example": "text" }, "encryption_protocol": { "type": "string", "description": "Connection encryption protocol ", "example": "" }, "mtu": { "type": "string", "description": "Enter the maximum package size that will pass through the IPSec VPN tunnel ", "example": "60" } } }, "VdcRouterVpn": { "type": "object", "properties": { "name": { "type": "string", "example": "text" }, "connection_type": { "type": "string", "enum": [ "2", "1", "3" ], "description": "Select a connection method of the IPSec VPN tunnel ; 2 - External organization network ; 1 - Organization network ; 3 - External network ", "example": "" }, "vdc_router_peer": { "type": "string", "description": "Select a router of the virtual data-center that the IPSec VPN tunnel will be configured ", "example": "" }, "vdc_network_local": { "type": "string", "description": "Local networks connected to the router ", "example": "" }, "vdc_network_peer": { "type": "string", "description": "External networks connected to the router of the virtual data-center ", "example": "" }, "peer_cidr": { "type": "string", "description": "External networks that the IPSec VPN tunnel is configured for. Supported format: address_network/mask, space separated. For example: 192.168.0.0/24 192.168.1.0/24", "example": "text" }, "encryption_protocol": { "type": "string", "description": "Connection encryption protocol ", "example": "" }, "mtu": { "type": "string", "description": "Enter the maximum package size that will pass through the IPSec VPN tunnel ", "example": "60" } } }, "VdcRouterLbpElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Name of the load balancer pool. It can contain only the Latin alphabet letters, digits, a dash, underscore, and must start with a letter " }, "description": { "type": "string", "description": "Enter any information related to this pool " }, "members": { "type": "string", "description": "Enter the number of pool members " }, "service": { "type": "string", "description": "Pool services " }, "port": { "type": "string", "description": "Service ports " }, "monitor_port": { "type": "string", "description": "Select a port that will be used for monitoring " }, "method": { "type": "string", "description": "Load balancing method " }, "interval": { "type": "string", "description": "Monitoring interval " }, "timeout": { "type": "string", "description": "Monitoring timeout " }, "status": { "type": "string" } } }, "VdcRouterLbpNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the load balancer pool. It can contain only the Latin alphabet letters, digits, a dash, underscore, and must start with a letter ", "example": "text" }, "uri": { "type": "string", "description": "URI for HTTP availability check ", "example": "" } } }, "VdcRouterLbp": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the load balancer pool. It can contain only the Latin alphabet letters, digits, a dash, underscore, and must start with a letter ", "example": "text" }, "uri": { "type": "string", "description": "URI for HTTP availability check ", "example": "" } } }, "VdcRouterLbsElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Enter the name of the load balancer server. It can contain the Latin alphabet letters, digits, a dash, underscore, and must start with a letter " }, "description": { "type": "string", "description": "Enter any information related to this server " }, "ip": { "type": "string", "description": "IP address of the load balancer server " }, "vdc_loadbalancer_pool_name": { "type": "string", "description": "Pool of the load balancer parameters " }, "service_name": { "type": "string", "description": "Enter the name of the service which is used by the load balancer " }, "service_port": { "type": "string", "description": "Port of the service which is used by the load balancer" }, "service_persistence": { "type": "string", "description": "Select a service connection persistence method" }, "status": { "type": "string" }, "use_log": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" } } }, "VdcRouterLbsNew": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter the name of the load balancer server. It can contain the Latin alphabet letters, digits, a dash, underscore, and must start with a letter ", "example": "text" }, "vdc_network": { "type": "string", "description": "Select the router network the load balancer will be activated for ", "example": "" }, "ip": { "type": "string", "description": "IP address of the load balancer server ", "example": "text" }, "pool": { "type": "string", "description": "Pool of the load balancer parameters ", "example": "" }, "use_log": { "type": "string", "enum": [ "on", "off" ], "description": "Activate logging of the traffic going through the load balancer server ", "example": "off" } } }, "VdcRouterLbs": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter the name of the load balancer server. It can contain the Latin alphabet letters, digits, a dash, underscore, and must start with a letter ", "example": "text" }, "vdc_network": { "type": "string", "description": "Select the router network the load balancer will be activated for ", "example": "" }, "ip": { "type": "string", "description": "IP address of the load balancer server ", "example": "text" }, "pool": { "type": "string", "description": "Pool of the load balancer parameters ", "example": "" }, "use_log": { "type": "string", "enum": [ "on", "off" ], "description": "Activate logging of the traffic going through the load balancer server ", "example": "off" } } }, "VdcLoadbalancerElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "externalid": { "type": "string", "description": "Balancer ID " }, "vm": { "type": "string", "description": "Select the virtual server connected to balancer " }, "protocol": { "type": "string", "description": "Incoming connection protocol " }, "port": { "type": "string", "description": "Port" }, "method": { "type": "string", "description": "Method of traffic distribution between pool members " }, "monitortype": { "type": "string", "description": "Monitoring protocol type " }, "delay": { "type": "string", "description": "Query interval, in seconds " }, "retries": { "type": "string", "description": "The number of successful check attempts before the status of the pool member will be changed. Possible values: 1 to 10. " }, "timeout": { "type": "string", "description": "The maximum waiting time for connection, in seconds " }, "status": { "type": "string" } } }, "VdcLoadbalancerNew": { "type": "object", "properties": { "name": { "type": "string", "example": "text" }, "subnet": { "type": "string", "description": "Select a subnet ", "example": "" }, "protocol": { "type": "string", "description": "Select protocol ", "example": "" }, "port": { "type": "string", "description": "Select a port. Possible values 1 to 65535 ", "example": "1" }, "method": { "type": "string", "description": "Method of traffic distribution between pool members ", "example": "" }, "vm": { "type": "string", "description": "Virtual servers from the pool ", "example": "" }, "monitortype": { "type": "string", "description": "Monitoring protocol type ", "example": "" }, "delay": { "type": "string", "description": "Query interval, in seconds ", "example": "1" }, "timeout": { "type": "string", "description": "The maximum waiting time for connection, in seconds ", "example": "1" } } }, "VdcLoadbalancer": { "type": "object", "properties": { "name": { "type": "string", "example": "text" }, "subnet": { "type": "string", "description": "Select a subnet ", "example": "" }, "protocol": { "type": "string", "description": "Select protocol ", "example": "" }, "port": { "type": "string", "description": "Select a port. Possible values 1 to 65535 ", "example": "1" }, "method": { "type": "string", "description": "Method of traffic distribution between pool members ", "example": "" }, "monitortype": { "type": "string", "description": "Monitoring protocol type ", "example": "" }, "delay": { "type": "string", "description": "Query interval, in seconds ", "example": "1" }, "timeout": { "type": "string", "description": "The maximum waiting time for connection, in seconds ", "example": "1" } } }, "VdcLoadbalancerVmElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "vm": { "type": "string" }, "subnet": { "type": "string", "description": "The subnet the virtual server is connected to " } } }, "VdcLoadbalancerVmNew": { "type": "object", "properties": { "vm": { "type": "string", "description": "Virtual server that will be connected to balancer ", "example": "" } } }, "VdcLoadbalancerIpElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "ip": { "type": "string" }, "status": { "type": "string" } } }, "VdcLoadbalancerIpNew": { "type": "object", "properties": { "iplist": { "type": "string", "description": "IP address that you want to connect to balancer ", "example": "" } } }, "VdsElem": { "type": "object", "properties": { "domain": { "type": "string", "description": "Name" }, "ip": { "type": "string", "description": "IP addresses" }, "ipv6_subnet": { "type": "string", "description": "IPv6 subnet" }, "ostempl": { "type": "string", "description": "Name of the operating system template " }, "processingnode": { "type": "string", "description": "Cluster node" }, "serverid": { "type": "string", "description": "Server name in the control panel " }, "rack": { "type": "string", "description": "The rack number where the cluster node is located " }, "id": { "type": "string", "description": "Id" }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "account": { "type": "string", "description": "Client who owns this service " }, "project": { "type": "string" }, "datacentername": { "type": "string", "description": "Data center where the service is located " }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "autoprolong": { "type": "string", "description": "Service auto renewal period. The service will be prolonged automatically on its expiration date " }, "status_msg": { "type": "string", "description": "Service current status ; KVM_access - KVM access; in_hardreboot - Rebooting; issue - Issue in progress; service_nosuitable - Not available ; in_suspend - Disable ; certificate_error - Issue error ; in_register - Registration in progress ; in_close - Deletion in progress ; in_reboot - Rebooting ; suspended - Suspended ; in_processing - In progress ; ordered - In Cart ; in_transfer - Registrar change; closed - Deleted ; active - Active ; need_configure - Complete configuration ; in_prolong - Renewal in progress ; in_resume - Resume ; in_pay - Payment in progress ; KVM_access - KVM access; in_hardreboot - Rebooting; issue - Issue in progress; service_nosuitable - Not available ; in_suspend - Disable ; certificate_error - Issue error ; in_register - Registration in progress ; in_close - Deletion in progress ; in_reboot - Rebooting ; suspended - Suspended ; in_processing - In progress ; ordered - In Cart ; in_transfer - Registrar change; closed - Deleted ; active - Active ; need_configure - Complete configuration ; in_prolong - Renewal in progress ; in_resume - Resume ; in_pay - Payment in progress ", "enum": [ "KVM_access", "in_hardreboot", "issue", "service_nosuitable", "in_suspend", "certificate_error", "in_register", "in_close", "in_reboot", "suspended", "in_processing", "ordered", "in_transfer", "closed", "active", "need_configure", "in_prolong", "in_resume", "in_pay", "KVM_access", "in_hardreboot", "issue", "service_nosuitable", "in_suspend", "certificate_error", "in_register", "in_close", "in_reboot", "suspended", "in_processing", "ordered", "in_transfer", "closed", "active", "need_configure", "in_prolong", "in_resume", "in_pay" ] }, "item_status": { "type": "string", "description": "Service status ; 5_reopen - Processed (reissue); hardreboot - Active (reboot); 2_hardreboot - Active (reboot); 5_hardreboot - Reboot in progress; 5_need_configure - Configuration required ; reboot - Active (reboot) ; 2_reboot - Active (reboot); 2_genkey - Active (key generation); 2_start - Active (activation in progress) ; 2_stop - Active (suspension in progress) ; 2_2_29 - Active (suspended by client) ; 2_2_16 - Temporary suspended ; service_nosuitable - Not available ; 2 - Active; 5_transfer - Transfer in progress ; 0 - Unknown ; 5 - In progress ; 5_close - Deletion in progress ; 3 - Suspended ; 1 - Ordered ; 5_open - Activation in progress ; 5_reboot - Reboot in progress ; 5_suspend - Suspension in progress ; 5_resume - Activation in progress ; 5_prolong - Renewal in progress ; 3_employeesuspend - Suspended by Administrator ; 4 - Deleted ; 3_abusesuspend - Suspended due to abuse ; 3_autosuspend - Suspended ; 5_reopen - Processed (reissue); hardreboot - Active (reboot); 2_hardreboot - Active (reboot); 5_hardreboot - Reboot in progress; 5_need_configure - Configuration required ; reboot - Active (reboot) ; 2_reboot - Active (reboot); 2_genkey - Active (key generation); 2_start - Active (activation in progress) ; 2_stop - Active (suspension in progress) ; 2_2_29 - Active (suspended by client) ; 2_2_16 - Temporary suspended ; service_nosuitable - Not available ; 2 - Active; 5_transfer - Transfer in progress ; 0 - Unknown ; 5 - In progress ; 5_close - Deletion in progress ; 3 - Suspended ; 1 - Ordered ; 5_open - Activation in progress ; 5_reboot - Reboot in progress ; 5_suspend - Suspension in progress ; 5_resume - Activation in progress ; 5_prolong - Renewal in progress ; 3_employeesuspend - Suspended by Administrator ; 4 - Deleted ; 3_abusesuspend - Suspended due to abuse ; 3_autosuspend - Suspended ", "enum": [ "5_reopen", "hardreboot", "2_hardreboot", "5_hardreboot", "5_need_configure", "reboot", "2_reboot", "2_genkey", "2_start", "2_stop", "2_2_29", "2_2_16", "service_nosuitable", "2", "5_transfer", "0", "5", "5_close", "3", "1", "5_open", "5_reboot", "5_suspend", "5_resume", "5_prolong", "3_employeesuspend", "4", "3_abusesuspend", "3_autosuspend", "5_reopen", "hardreboot", "2_hardreboot", "5_hardreboot", "5_need_configure", "reboot", "2_reboot", "2_genkey", "2_start", "2_stop", "2_2_29", "2_2_16", "service_nosuitable", "2", "5_transfer", "0", "5", "5_close", "3", "1", "5_open", "5_reboot", "5_suspend", "5_resume", "5_prolong", "3_employeesuspend", "4", "3_abusesuspend", "3_autosuspend" ] }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "processingmodule_failed": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "archived": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "Vds": { "type": "object", "properties": { "change_disk_size_warn": { "type": "string", "description": "This operation allows to set limits according to the selected values. Note: the disk size won't be modified. You need to perform this operation manually on the server", "example": "" }, "change_disc_size": { "type": "string", "enum": [ "on", "off" ], "description": "Select the check box to confirm that all the operations (such as activation/suspension of a virtual server, change of its disk size) were performed ", "example": "off" }, "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "processingmodule": { "type": "string", "description": "Processing module", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "description": "Service will be deleted after paid period ", "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "description": "Reboot the server in the control panel ", "example": "off" }, "noexpense": { "type": "string", "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "" } } }, "VhostElem": { "type": "object", "properties": { "domain": { "type": "string", "description": "Name" }, "ip": { "type": "string", "description": "IP addresses" }, "processingnode": { "type": "string" }, "username": { "type": "string" }, "id": { "type": "string", "description": "Id" }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "account": { "type": "string", "description": "Client who owns this service " }, "project": { "type": "string" }, "datacentername": { "type": "string", "description": "Data center where the service is located " }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "autoprolong": { "type": "string", "description": "Service auto renewal period. The service will be prolonged automatically on its expiration date " }, "status_msg": { "type": "string", "description": "Service current status " }, "item_status": { "type": "string", "description": "Service status " }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "processingmodule_failed": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "archived": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "Vhost": { "type": "object", "properties": { "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "processingmodule": { "type": "string", "description": "Processing module", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "description": "Service will be deleted after paid period ", "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "description": "Reboot the server in the control panel ", "example": "off" }, "noexpense": { "type": "string", "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "" } } }, "VirtualNetworkElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Id" }, "pricelist": { "type": "string", "description": "Tariff plan associated with this service " }, "account": { "type": "string", "description": "Client who owns this service " }, "project": { "type": "string" }, "datacentername": { "type": "string", "description": "Data center where the service is located " }, "processingmodule": { "type": "string", "description": "Service processing module " }, "createdate": { "type": "string", "description": "Service creation date" }, "expiredate": { "type": "string", "description": "Date when the service will become invalid " }, "autoprolong": { "type": "string", "description": "Service auto renewal period. The service will be prolonged automatically on its expiration date " }, "status_msg": { "type": "string", "description": "Service current status " }, "item_status": { "type": "string", "description": "Service status " }, "need_configure": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "processingmodule_failed": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "subscription": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "archived": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag" }, "cost": { "type": "string", "description": "Full service renewal price for the minimum order period including all additions" } } }, "VirtualNetwork": { "type": "object", "properties": { "autoprolong": { "type": "string", "enum": [ "warning_tmpl", "warning_penalty_tmpl", "disabled", "warning_tmpl", "warning_penalty_tmpl", "disabled", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120", "-50", "0", "1", "12", "24", "3", "36", "48", "6", "60", "120" ], "description": "Select the period for which the service will be automatically renewed when it expires; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; warning_tmpl - Currently, the service is suspended and cannot be renewed automatically.\n Renewal cost till __expiredate__ is __cost__ __iso____penalty_msg__. To renew the service, click \"Add to Cart\" ; warning_penalty_tmpl - , including the downtime fee __penalty__ __iso__ ; disabled - Disabled; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ; -50 - Day; 0 - lifetime order period ; 1 - Month; 12 - Year; 24 - Two years; 3 - Three months; 36 - Three years; 48 - Four years; 6 - Half a year; 60 - five years ; 120 - ten years ", "example": "" }, "stored_method": { "type": "string", "enum": [ "warning", "warning" ], "description": "Payment method, by means of which the service auto-renewal will take place ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ; warning - There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "stored_method_warning": { "type": "string", "description": "There are no configured payment methods, you need to create a payment method in the \"Payment methods\" section. ", "example": "" }, "processingmodule": { "type": "string", "description": "Processing module", "example": "" }, "createdate": { "type": "string", "description": "Date when the service was ordered ", "example": "" }, "opendate": { "type": "string", "description": "Activation date", "example": "" }, "expiredate": { "type": "string", "description": "Validity period", "example": "" }, "scheduledclose": { "type": "string", "enum": [ "on", "off" ], "description": "Service will be deleted after paid period ", "example": "off" }, "description": { "type": "string", "example": "" }, "show_rebootwarn": { "type": "string", "example": "" }, "reboot": { "type": "string", "enum": [ "on", "off" ], "description": "Reboot the server in the control panel ", "example": "off" }, "noexpense": { "type": "string", "description": "Select the check box if you don't want to charge/refund a client if his service resources have been changed ", "example": "" } } }, "PaymethodElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Name of the payment method that will be shown to clients" }, "module": { "type": "string", "description": "Enter the name of the payment system" }, "currency_name": { "type": "string", "description": "Select a currency for payments. If the paньуте currency does not match the one selected by a client, the amount will be shown according to the currency exchange rate" }, "projects": { "type": "string", "description": "Select providers who will be able to use this payment method" }, "companies": { "type": "string", "description": "Companies that use this payment method " }, "note": { "type": "string", "description": "Add your comment to the payment method" }, "orderpriority": { "type": "string", "description": "Set priority for the selected payment method (count forward). Payment methods will be shown to clients according to this priority " }, "status": { "type": "string", "description": "Current status of the payment method " }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"Payment method is active \"; value \"off\": \"Payment method is disabled \"" }, "verified": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"The payment method is verified\"" }, "wrnport": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Flag. Value \"on\": \"This payment method can run only on ports 443, 80 \"" } } }, "PaymethodNew": { "type": "object", "properties": { "name": { "type": "string", "example": "text" }, "currency": { "type": "string", "description": "Select currency to make a payment", "example": "50" }, "minamount": { "type": "string", "description": "Enter the minimum payment amount for the selected payment method", "example": "text" }, "maxamount": { "type": "string", "description": "Enter the maximum payment amount that can be made with this payment method", "example": "" }, "commissionamount": { "type": "string", "description": "This fixed amount will be debited from client's account after the payment is effected", "example": "" }, "commissionpercent": { "type": "string", "description": "Commission in % that will be debited from client's account after the payment is effected", "example": "0.0" }, "autoclearperiod": { "type": "string", "description": "Period in days since the payment creation date, that will pass before a due payment will be deleted", "example": "1" }, "active": { "type": "string", "enum": [ "on", "off" ], "description": "This payment method will be activated upon creation", "example": "off" }, "orderpriority": { "type": "string", "description": "Set priority for the selected payment method (count forward). Payment methods will be shown to clients according to this priority ", "example": "1" }, "successpage": { "type": "string", "description": "A payer will be redirected to this page if his payment is processed successfully ", "example": "http://example.com" }, "failpage": { "type": "string", "description": "A payer will be redirected to this page if his payment fails", "example": "http://example.com" }, "pendingpage": { "type": "string", "description": "A payer will be redirected to this page if his payment is \"Pending\". Some payments may have the \"Pending\" status after the payment procedure and can be confirmed or canceled later. You can specify a return page for such payments. ", "example": "http://example.com" }, "project": { "type": "string", "description": "The newly created payment method will be activated upon creation for the selected provider and will be available to clients registered only with this provider. If no providers are selected, payment methods won't be available at all", "example": "" }, "profiletype": { "type": "string", "description": "Select a payer status", "example": "1,2,3" }, "hide_profiletype": { "type": "string", "example": "" }, "company": { "type": "string", "description": "Select a company that will use this payment method after creation. This will allow you to use information about payments. Note: your client will have to enter payer's information. We recommend that you add payment methods available to companies only. ", "example": "" }, "assign_company": { "type": "string", "enum": [ "on", "off" ], "description": "This payment method will be used in the company's accounting system ", "example": "off" }, "doctmpl": { "type": "string", "description": "Select a template for printing the document. If it is not specified, the one from the company edit form will be used", "example": "" }, "numtmpl_payment": { "type": "string", "description": "In the invoice template you can use the following macros: {id} - payment id and {num} - number of the payment generated with this payment method. If these macros are not present, the {num} macros will be added to the invoice template number ", "example": "" }, "nextnum_payment": { "type": "string", "description": "Next numerical order of the invoice that was created with this payment method. It is taken into account provided that invoice number template is specified ", "example": "1" } } }, "PaymethodNew_wire": { "type": "object", "properties": { "recipient_name": { "type": "string", "description": "Select a company that will receive payments ", "example": "text" }, "bankname": { "type": "string", "description": "Enter the name of the bank ", "example": "text" }, "swift": { "type": "string", "description": "Enter the SWIFT code ", "example": "text" }, "account": { "type": "string", "description": "Enter the bank account number ", "example": "text" }, "iban": { "type": "string", "description": "Enter IBAN", "example": "text" } } }, "PaymethodNew_ruwire": { "type": "object", "properties": { "recipient_name": { "type": "string", "description": "Select a company that will receive payments ", "example": "text" }, "bankname": { "type": "string", "description": "Enter the name of the bank ", "example": "text" }, "bik": { "type": "string", "description": "Enter BIK", "example": "000000000" }, "rs": { "type": "string", "description": "Settlement account ", "example": "text" }, "ks": { "type": "string", "description": "Correspondent account ", "example": "text" } } }, "Paymethod": { "type": "object", "properties": { "name": { "type": "string", "description": "Enter the name for the payment method", "example": "text" }, "minamount": { "type": "string", "description": "Enter the minimum payment amount for the selected payment method", "example": "text" }, "maxamount": { "type": "string", "description": "Enter the maximum payment amount that can be made with this payment method", "example": "" }, "commissionamount": { "type": "string", "description": "This fixed amount will be debited from client's account after the payment is effected", "example": "" }, "commissionpercent": { "type": "string", "description": "Commission in % that will be debited from client's account after the payment is effected", "example": "0.0" }, "doctmpl": { "type": "string", "description": "Select a template for printing the document. If it is not specified, the one from the company edit form will be used", "example": "" }, "numtmpl_payment": { "type": "string", "description": "In the invoice template you can use the following macros: {id} - payment id and {num} - number of the payment generated with this payment method. If these macros are not present, the {num} macros will be added to the invoice template number ", "example": "" }, "nextnum_payment": { "type": "string", "description": "Next numerical order of the invoice that was created with this payment method. It is taken into account provided that invoice number template is specified ", "example": "1" }, "payment_description": { "type": "string", "description": "Name of the advance payment in the Payments module ", "example": "" }, "autoclearperiod": { "type": "string", "description": "Period in days since the payment creation date, that will pass before a due payment will be deleted", "example": "1" }, "pay_img_upload": { "type": "string", "description": "Upload icon", "example": "" }, "orderpriority": { "type": "string", "description": "Set priority for the selected payment method", "example": "1" }, "successpage": { "type": "string", "description": "A payer will be redirected to this page if his payment is processed successfully ", "example": "http://example.com" }, "failpage": { "type": "string", "description": "A payer will be redirected to this page if his payment fails", "example": "http://example.com" }, "pendingpage": { "type": "string", "description": "A payer will be redirected to this page if his payment is \"Pending\". Some payments may have the \"Pending\" status after the payment procedure and can be confirmed or canceled later. You can specify a return page for such payments. ", "example": "http://example.com" }, "assign_company": { "type": "string", "enum": [ "on", "off" ], "description": "This payment method will be used by the company's accounting system ", "example": "off" }, "profiletype": { "type": "string", "enum": [ "1", "2", "3", "1", "2", "3", "1", "2", "3", "1", "2", "3" ], "description": "This payment method will be available to payers with the selected status; 1 - Individual; 2 - Company; 3 - Sole proprietor; 1 - Individual; 2 - Company; 3 - Sole proprietor; 1 - Individual; 2 - Company; 3 - Sole proprietor; 1 - Individual; 2 - Company; 3 - Sole proprietor", "example": "" }, "accountgroup": { "type": "string", "description": "Select the check box to allow users from the selected group to use this payment module", "example": "" }, "deny_accountgroup": { "type": "string", "description": "Enables to forbid clients from the selected groups to use this payment method ", "example": "" }, "language": { "type": "string", "description": "This payment method will be available if the interface language matches one of the selected languages. If the language is not selected, this payment method will be available for all languages", "example": "" }, "verified": { "type": "string", "enum": [ "on", "off" ], "description": "The payment method can be used as a way of client identification", "example": "off" }, "recurring": { "type": "string", "enum": [ "on", "off" ], "description": "Enable recurring payments. It is also used for the activation of saved payment methods if the payment system supports this feature. ", "example": "off" }, "successpage_recurring": { "type": "string", "description": "A payer will be redirected to this page if his automatic payment is processed successfully ", "example": "http://example.com" }, "failpage_recurring": { "type": "string", "description": "A payer will be redirected to this page if his automatic payment fails", "example": "http://example.com" }, "pendingpage_recurring": { "type": "string", "description": "A payer will be redirected to this page if his auto-payment is \"Pending\". Some payments may have the \"Pending\" status after the payment procedure and can be confirmed or canceled later. You can specify a return page for such payments. ", "example": "http://example.com" }, "successpage_subscription": { "type": "string", "description": "Enter the page to which the payer will be redirected after the subscription is configured successfully ", "example": "http://example.com" }, "failpage_subscription": { "type": "string", "description": "Enter the page to which the payer will be redirected if the subscription is not configured ", "example": "http://example.com" }, "pendingpage_subscription": { "type": "string", "description": "Enter the page to which the payer will be redirected if the subscription status is \"pending\" ", "example": "http://example.com" }, "allowrefund": { "type": "string", "enum": [ "on", "off" ], "description": "Allow full or partial refunds using the selected payment method", "example": "off" } } }, "Paymethod_wire": { "type": "object", "properties": { "recipient_name": { "type": "string", "description": "Select a company that will receive payments ", "example": "text" }, "bankname": { "type": "string", "description": "Enter the name of the bank ", "example": "text" }, "swift": { "type": "string", "description": "Enter the SWIFT code ", "example": "text" }, "account": { "type": "string", "description": "Enter the bank account number ", "example": "text" }, "iban": { "type": "string", "description": "Enter IBAN", "example": "text" } } }, "Paymethod_ruwire": { "type": "object", "properties": { "recipient_name": { "type": "string", "description": "Select a company that will receive payments ", "example": "text" }, "bankname": { "type": "string", "description": "Enter the name of the bank ", "example": "text" }, "bik": { "type": "string", "description": "Enter BIK", "example": "000000000" }, "rs": { "type": "string", "description": "Settlement account ", "example": "text" }, "ks": { "type": "string", "description": "Correspondent account ", "example": "text" } } }, "PaymethodProjectElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "status": { "type": "string" }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" } } }, "PaymethodCompanyElem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identificator", "example": "1" }, "name": { "type": "string", "description": "Entity name" }, "status": { "type": "string", "description": "Current status of this payment system against the company " }, "active": { "type": "string", "enum": [ "on", "off" ], "example": "on", "description": "Activity flag" } } }, "OrderParamV2": { "type": "object", "properties": { "order_period": { "type": "int", "enum": [ 1, 3, 6, 12, 24, 36 ], "description": "Order period", "example": 1 }, "pricelist": { "type": "int", "description": "Tariff ID", "example": 1 }, "autoprolong": { "type": "string", "enum": [ "on", "off" ], "description": "Enable auto-renewal", "example": "on" }, "datacenter": { "type": "int", "description": "ID of the data center where the service will be opened", "example": 1 }, "force_use_new_cart": { "type": "string", "enum": [ "on", "off" ], "description": "Enable use of the new shopping cart", "example": "on" }, "addon_{ADDON_PRICELIST_ID}": { "type": "string", "description": "\nAddon value.\nThe value depends on the setting of the addon in the tariff plan\n\nTariff addons are passed through the API via the addon_ parameter. For example, addon_5=10, where\n\n 5 is the addon code,\n 10 - value.\n\nTo find the addon code, enter Products → Tariff plan → Options → Id field\n" }, "skipbasket": { "type": "string", "enum": [ "on", "off" ], "description": "Enable payment for the service from the personal account without placing it in the cart", "example": "on" } } }, "CartOrderPaymethod": { "type": "object", "properties": { "paymethod_id": { "type": "int", "description": "payment method ID", "example": 1 }, "store_paymethod": { "type": "string", "enum": [ "on", "off" ], "description": "\nIf the parameter assumes the value \"on\" and the payment method supports the option to save the selected payment method, the method of this payment will be saved for the client\n", "example": "on" } } }, "CartOrderStoredmethod": { "type": "object", "properties": { "storedmethod_id": { "type": "int", "description": "ID сохраненного способа оплаты", "example": 1 } } } } }, "tags": [ { "name": "auth", "description": "Authorization" }, { "name": "project", "description": "Providers" }, { "name": "company", "description": "Companies" }, { "name": "paymethod", "description": "Payment methods" }, { "name": "account", "description": "Clients" }, { "name": "subaccount", "description": "Client accounts" }, { "name": "profile", "description": "Payers" }, { "name": "contract", "description": "Contracts" }, { "name": "accountgroup", "description": "Client groups" }, { "name": "payment", "description": "Payments" }, { "name": "expense", "description": "Expenses" }, { "name": "pricelist", "description": "Tariff plans" }, { "name": "pricelistgroup", "description": "Tariff groups" }, { "name": "itemtype", "description": "Product types" }, { "name": "order" }, { "name": "soft", "description": "Licenses" }, { "name": "addition", "description": "Modules" }, { "name": "softexternal", "description": "Other software" }, { "name": "vhost", "description": "Shared hosting" }, { "name": "dnshost", "description": "DNS hosting" }, { "name": "colocation", "description": "Colocation" }, { "name": "vds", "description": "Virtual private servers " }, { "name": "virtual_network", "description": "Virtual private networks " }, { "name": "certificate", "description": "SSL certificates " }, { "name": "dedic", "description": "Dedicated servers" }, { "name": "vdc", "description": null }, { "name": "domain", "description": "Domains" }, { "name": "paidsupport", "description": "Per-incident support " }, { "name": "storage", "description": "External FTP-storage " }, { "name": "backupservice", "description": "Backup" }, { "name": "locale", "description": "Localizations" }, { "name": "currency", "description": "Currencies" }, { "name": "currencyrate", "description": "Exchange rates" }, { "name": "promotion", "description": "Promotions " } ], "paths": { "?func=auth": { "get": { "tags": [ "auth" ], "summary": "Authorization by login and password", "parameters": [ { "in": "query", "name": "username", "schema": { "type": "string" }, "description": "Username" }, { "in": "query", "name": "password", "schema": { "type": "string" }, "description": "Password" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "auth": { "model": { "type": "object", "properties": { "auth": { "type": "string", "example": "9698eff6c576ed85f5b57875", "description": "Session ID" } } } } } } } } } } } }, "?func=locale": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of locales", "tags": [ "locale" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/LocaleElem" } } } } } } } } } }, "?func=locale.edit": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create locale", "tags": [ "locale" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "locale.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/LocaleNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "locale.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=locale.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit locale", "tags": [ "locale" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "locale.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Locale" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "locale.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=locale.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete locale", "tags": [ "locale" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "locale.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "locale.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=locale.resume&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable locale", "tags": [ "locale" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "locale.resume" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "locale.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=locale.suspend&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable locale", "tags": [ "locale" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "locale.suspend" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "locale.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=locale.setdefault&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Set the default localization", "tags": [ "locale" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "locale.setdefault" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/LocaleSetdefault" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "locale.setdefault" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=currency": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of currencies", "tags": [ "currency" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyElem" } } } } } } } } } }, "?func=currency.edit": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create currency", "tags": [ "currency" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currency.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/CurrencyNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currency.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=currency.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit currency", "tags": [ "currency" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currency.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Currency" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currency.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=currency.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete currency", "tags": [ "currency" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currency.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currency.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=currency.resume&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable currency", "tags": [ "currency" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currency.resume" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currency.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=currency.suspend&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable currency", "tags": [ "currency" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currency.suspend" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currency.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=currency.relate&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Exchange rates", "tags": [ "currency" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyRelateElem" } } } } } } } } } }, "?func=currencyrate&plid={plid}&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of currency rates by date", "tags": [ "currencyrate" ], "parameters": [ { "in": "query", "name": "plid", "schema": { "type": "int" }, "description": "Unique identifier of the parent element" }, { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyrateElem" } } } } } } } } } }, "?func=currencyrate.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create currency rate", "tags": [ "currencyrate" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currencyrate.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/CurrencyrateNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currencyrate.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=currencyrate.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit currency rate", "tags": [ "currencyrate" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currencyrate.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Currencyrate" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currencyrate.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=currencyrate.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete currency rate", "tags": [ "currencyrate" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currencyrate.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currencyrate.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=currencyrate.upload&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Upload exchange rate", "tags": [ "currencyrate" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currencyrate.upload" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/CurrencyrateUpload" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currencyrate.upload" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=currency.upload": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Update exchange rates", "tags": [ "currency" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currency.upload" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/CurrencyUpload" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "currency.upload" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of providers", "tags": [ "project" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectElem" } } } } } } } } } }, "?func=project.edit": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create provider", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ProjectNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=project.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit provider", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Project" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete provider", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.locale&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of locales", "tags": [ "project" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectLocaleElem" } } } } } } } } } }, "?func=project.locale.resume&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable project locale", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.locale.resume" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.locale.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.locale.suspend&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable project locale", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.locale.suspend" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.locale.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.company&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of provider companies", "tags": [ "project" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectCompanyElem" } } } } } } } } } }, "?func=project.company.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit provider and company configuration", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.company.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ProjectCompany" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.company.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.company.resume&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable provider company", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.company.resume" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.company.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.company.suspend&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable provider company", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.company.suspend" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.company.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.support&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Technical support settings ", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.support" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ProjectSupport" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.support" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.taxrule&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of provider tax rules", "tags": [ "project" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTaxruleElem" } } } } } } } } } }, "?func=project.taxrule.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create provider tax rule", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.taxrule.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ProjectTaxruleNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.taxrule.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=project.taxrule.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit provider tax rule", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.taxrule.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ProjectTaxrule" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.taxrule.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.taxrule.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete provider tax rule", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.taxrule.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.taxrule.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.taxrule.settings&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Tax settings ", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.taxrule.settings" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ProjectTaxruleSettings" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.taxrule.settings" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.group&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of provider groups", "tags": [ "project" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectGroupElem" } } } } } } } } } }, "?func=project.group.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create provider group", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.group.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ProjectGroupNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.group.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=project.group.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit provider group", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.group.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ProjectGroup" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.group.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.group.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete provider group", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.group.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.group.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.group.suspend&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable provider group", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.group.suspend" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.group.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.itemtype&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of provider product types", "tags": [ "project" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectItemtypeElem" } } } } } } } } } }, "?func=project.itemtype.up&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Move the selected product type one line up ", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.itemtype.up" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.itemtype.up" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.itemtype.down&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Move the selected product type one line down", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.itemtype.down" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.itemtype.down" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.currency&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of provider currencies", "tags": [ "project" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectCurrencyElem" } } } } } } } } } }, "?func=project.currency.resume&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable provider currency", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.currency.resume" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.currency.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=project.currency.suspend&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable provider currency", "tags": [ "project" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.currency.suspend" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "project.currency.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=company": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of companies", "tags": [ "company" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyElem" } } } } } } } } } }, "?func=company.add": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create company", "tags": [ "company" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.add" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/CompanyAddNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.add" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=company.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit company", "tags": [ "company" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Company" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=company.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete company", "tags": [ "company" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=company.contract&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of company contracts", "tags": [ "company" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyContractElem" } } } } } } } } } }, "?func=company.contract.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create company contract", "tags": [ "company" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.contract.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/CompanyContractNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.contract.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=company.contract.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit company contract", "tags": [ "company" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.contract.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/CompanyContract" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.contract.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=company.contract.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete company contract", "tags": [ "company" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.contract.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.contract.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=company.contract.appendix&plid={plid}&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of examples of contract annexes", "tags": [ "company" ], "parameters": [ { "in": "query", "name": "plid", "schema": { "type": "int" }, "description": "Unique identifier of the parent element" }, { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyContractAppendixElem" } } } } } } } } } }, "?func=company.contract.appendix.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create example of contract annexes", "tags": [ "company" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.contract.appendix.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/CompanyContractAppendixNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.contract.appendix.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=company.contract.appendix.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit example of contract annexes", "tags": [ "company" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.contract.appendix.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/CompanyContractAppendix" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.contract.appendix.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=company.contract.appendix.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete example of contract annexes", "tags": [ "company" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.contract.appendix.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.contract.appendix.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=company.project&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of company providers", "tags": [ "company" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyProjectElem" } } } } } } } } } }, "?func=company.project.resume&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable company provider", "tags": [ "company" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.project.resume" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.project.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=company.project.suspend&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable company provider", "tags": [ "company" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.project.suspend" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "company.project.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=account": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of clients", "tags": [ "account" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/AccountElem" } } } } } } } } } }, "?func=account.edit": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create client", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/AccountNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=account.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit client", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Account" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=account.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete client", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=account.group&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of client groups", "tags": [ "account" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/AccountGroupElem" } } } } } } } } } }, "?func=account.group.resume&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable client group", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.group.resume" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.group.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=account.group.suspend&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable client group", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.group.suspend" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.group.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=account.orders&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Orders", "tags": [ "account" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/AccountOrdersElem" } } } } } } } } } }, "?func=account.orders.project.order&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Select a provider", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.orders.project.order" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/AccountOrdersProjectOrder" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.orders.project.order" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=account.orders.project.cart&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Select a provider", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.orders.project.cart" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/AccountOrdersProjectCart" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.orders.project.cart" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=account.orders.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": null, "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.orders.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/AccountOrders" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.orders.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=account.project&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of client providers", "tags": [ "account" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/AccountProjectElem" } } } } } } } } } }, "?func=account.project.resume&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable client provider", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.project.resume" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.project.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=account.project.suspend&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable client provider", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.project.suspend" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.project.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=subaccount&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of client personal accounts", "tags": [ "subaccount" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/SubaccountElem" } } } } } } } } } }, "?func=subaccount.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create client personal account", "tags": [ "subaccount" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/SubaccountNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=subaccount.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit client personal account", "tags": [ "subaccount" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Subaccount" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=subaccount.resume&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable client personal account", "tags": [ "subaccount" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.resume" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=subaccount.suspend&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable client personal account", "tags": [ "subaccount" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.suspend" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=subaccount.refund&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Refund", "tags": [ "subaccount" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.refund" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/SubaccountRefund" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.refund" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=account.discount&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of personal client discounts", "tags": [ "account" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/AccountDiscountElem" } } } } } } } } } }, "?func=account.discount.add&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create personal client discount", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.discount.add" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/AccountDiscountAddNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.discount.add" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=account.discount.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit personal client discount", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.discount.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/AccountDiscount" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.discount.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=account.discount.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete personal client discount", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.discount.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.discount.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=account.currencyrate&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of personal client currency rate", "tags": [ "account" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/AccountCurrencyrateElem" } } } } } } } } } }, "?func=account.currencyrate.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create personal client currency rate", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.currencyrate.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/AccountCurrencyrateNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.currencyrate.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=account.currencyrate.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit personal client currency rate", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.currencyrate.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/AccountCurrencyrate" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.currencyrate.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=account.currencyrate.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete personal client currency rate", "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.currencyrate.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.currencyrate.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=subaccount.expense&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of personal account expenses", "tags": [ "subaccount" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/SubaccountExpenseElem" } } } } } } } } } }, "?func=subaccount.expense.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create personal account expense", "tags": [ "subaccount" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.expense.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/SubaccountExpenseNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.expense.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=subaccount.expense.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit personal account expense", "tags": [ "subaccount" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.expense.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/SubaccountExpense" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.expense.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=subaccount.expense.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete personal account expense", "tags": [ "subaccount" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.expense.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "subaccount.expense.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=expense.payment&plid={plid}&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of expense payments", "tags": [ "expense" ], "parameters": [ { "in": "query", "name": "plid", "schema": { "type": "int" }, "description": "Unique identifier of the parent element" }, { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ExpensePaymentElem" } } } } } } } } } }, "?func=expense.payment.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create expense payment", "tags": [ "expense" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "expense.payment.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ExpensePaymentNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "expense.payment.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=expense.payment.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit expense payment", "tags": [ "expense" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "expense.payment.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ExpensePayment" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "expense.payment.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=expense.payment.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete expense payment", "tags": [ "expense" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "expense.payment.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "expense.payment.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=payment.expense": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of payment expenses", "tags": [ "payment" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentExpenseElem" } } } } } } } } } }, "?func=payment.expense.edit": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create payment expense", "tags": [ "payment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.expense.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PaymentExpenseNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.expense.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=payment.expense.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit payment expense", "tags": [ "payment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.expense.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PaymentExpense" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.expense.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=payment.expense.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete payment expense", "tags": [ "payment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.expense.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.expense.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=expense": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of expenses", "tags": [ "expense" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseElem" } } } } } } } } } }, "?func=expense.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit expense", "tags": [ "expense" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "expense.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Expense" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "expense.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=expense.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete expense", "tags": [ "expense" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "expense.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "expense.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=profile": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of payers", "tags": [ "profile" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ProfileElem" } } } } } } } } } }, "?func=profile.add": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create payer", "tags": [ "profile" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.add" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ProfileAddNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.add" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=profile.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit payer", "tags": [ "profile" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Profile" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=profile.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete payer", "tags": [ "profile" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=profile.company&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of payer companies", "tags": [ "profile" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ProfileCompanyElem" } } } } } } } } } }, "?func=profile.company.resume&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable payer company", "tags": [ "profile" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.company.resume" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.company.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=profile.company.suspend&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable payer company", "tags": [ "profile" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.company.suspend" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.company.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=profile.resume&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable payer", "tags": [ "profile" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.resume" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=profile.suspend&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable payer", "tags": [ "profile" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.suspend" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=profile.reconciliation&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Print the reconciliation report", "tags": [ "profile" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.reconciliation" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ProfileReconciliation" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "profile.reconciliation" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=profile.history&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Payer parameters change history", "tags": [ "profile" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ProfileHistoryElem" } } } } } } } } } }, "?func=account.orders.itemtype": { "post": { "security": [ { "SessionAuth": [] } ], "summary": null, "tags": [ "account" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.orders.itemtype" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/AccountOrdersItemtype" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "account.orders.itemtype" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=contract": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of contracts", "tags": [ "contract" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ContractElem" } } } } } } } } } }, "?func=contract.edit": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create contract", "tags": [ "contract" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "contract.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ContractNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "contract.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=contract.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit contract", "tags": [ "contract" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "contract.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Contract" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "contract.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=contract.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete contract", "tags": [ "contract" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "contract.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "contract.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=contract.item&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Services", "tags": [ "contract" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ContractItemElem" } } } } } } } } } }, "?func=contract.item.resume&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": null, "tags": [ "contract" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "contract.item.resume" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "contract.item.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=contract.item.suspend&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": null, "tags": [ "contract" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "contract.item.suspend" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "contract.item.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=accountgroup": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of client groups", "tags": [ "accountgroup" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/AccountgroupElem" } } } } } } } } } }, "?func=accountgroup.edit": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create client group", "tags": [ "accountgroup" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/AccountgroupNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=accountgroup.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit client group", "tags": [ "accountgroup" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Accountgroup" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=accountgroup.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete client group", "tags": [ "accountgroup" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=accountgroup.account&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of clients - group members", "tags": [ "accountgroup" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/AccountgroupAccountElem" } } } } } } } } } }, "?func=accountgroup.account.resume&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable client as group member", "tags": [ "accountgroup" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.account.resume" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.account.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=accountgroup.account.suspend&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable client as group member", "tags": [ "accountgroup" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.account.suspend" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.account.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=accountgroup.taxrule&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of tax rules for the client groups", "tags": [ "accountgroup" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/AccountgroupTaxruleElem" } } } } } } } } } }, "?func=accountgroup.taxrule.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create tax rule for the client group", "tags": [ "accountgroup" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.taxrule.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/AccountgroupTaxruleNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.taxrule.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=accountgroup.taxrule.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit tax rule for the client group", "tags": [ "accountgroup" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.taxrule.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/AccountgroupTaxrule" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.taxrule.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=accountgroup.taxrule.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete tax rule for the client group", "tags": [ "accountgroup" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.taxrule.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.taxrule.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=accountgroup.taxrule.settings&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Tax settings ", "tags": [ "accountgroup" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.taxrule.settings" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/AccountgroupTaxruleSettings" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "accountgroup.taxrule.settings" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=accountgroup.history&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Group parameters history ", "tags": [ "accountgroup" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/AccountgroupHistoryElem" } } } } } } } } } }, "?func=accountgroup.condition&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of conditions to assign a client to group automatically", "tags": [ "accountgroup" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/AccountgroupConditionElem" } } } } } } } } } }, "?func=payment": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of payments", "tags": [ "payment" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentElem" } } } } } } } } } }, "?func=payment.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit payment", "tags": [ "payment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Payment" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=payment.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete payment", "tags": [ "payment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=payment.refund&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Refund", "tags": [ "payment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.refund" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PaymentRefund" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.refund" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=payment.orderinfo&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of invoice items", "tags": [ "payment" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentOrderinfoElem" } } } } } } } } } }, "?func=payment.orderinfo.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit invoice item", "tags": [ "payment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.orderinfo.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PaymentOrderinfo" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "payment.orderinfo.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=payment.history&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Payment history", "tags": [ "payment" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentHistoryElem" } } } } } } } } } }, "?func=pricelist": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of tariffs", "tags": [ "pricelist" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PricelistElem" } } } } } } } } } }, "?func=pricelist.archived&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Tariffs archive", "tags": [ "pricelist" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PricelistArchivedElem" } } } } } } } } } }, "?func=pricelist.extract_archive&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Extract from archive", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.extract_archive" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistExtractArchive" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.extract_archive" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.up&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Move the tariff plan one line up", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.up" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.up" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.down&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Move the tariff plan one line down", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.down" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.down" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.add": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create tariff", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.add" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistAddNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.add" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=pricelist.clone&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Select a provider", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.clone" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistClone" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.clone" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.import": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Pricelist import", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.import" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistImport" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.import" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.resume&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable tariff", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.resume" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.suspend&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable tariff", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.suspend" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.edit": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit properties of the selected tariff plan", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.edit" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Pricelist" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.processing": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of pricelist processing modules", "tags": [ "pricelist" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PricelistProcessingElem" } } } } } } } } } }, "?func=pricelist.processing.resume&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable pricelist processing module", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.processing.resume" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.processing.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.processing.suspend&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable pricelist processing module", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.processing.suspend" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.processing.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.processing.up&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Put the processing module one position up ", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.processing.up" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.processing.up" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.processing.down&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Put the processing module one position down ", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.processing.down" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.processing.down" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of tariff addons", "tags": [ "pricelist" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PricelistDetailElem" } } } } } } } } } }, "?func=pricelist.detail.edit": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create tariff addon", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistDetailNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=pricelist.detail.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit tariff addon", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistDetail" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete tariff addon", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail.resume&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable tariff addon", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.resume" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail.suspend&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable tariff addon", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.suspend" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail.enum&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of addon prices with value type \"enumeration\"", "tags": [ "pricelist" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PricelistDetailEnumElem" } } } } } } } } } }, "?func=pricelist.detail.enum.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit addon price with value type \"enumeration\"", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.enum.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistDetailEnum" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.enum.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail.enum.resume&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable addon price with value type \"enumeration\"", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.enum.resume" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.enum.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail.enum.suspend&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable addon price with value type \"enumeration\"", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.enum.suspend" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.enum.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail.enum.up&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Move the price one position up", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.enum.up" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.enum.up" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail.enum.down&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Move the price down one position", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.enum.down" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.enum.down" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail.integer&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of addon prices with value type \"integer\"", "tags": [ "pricelist" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PricelistDetailIntegerElem" } } } } } } } } } }, "?func=pricelist.detail.integer.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create addon price with value type \"integer\"", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.integer.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistDetailIntegerNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.integer.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=pricelist.detail.integer.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit addon price with value type \"integer\"", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.integer.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistDetailInteger" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.integer.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail.integer.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete addon price with value type \"integer\"", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.integer.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.integer.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail.compound&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of addon variants", "tags": [ "pricelist" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PricelistDetailCompoundElem" } } } } } } } } } }, "?func=pricelist.detail.compound.up&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Move the selected add-on one line up", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.compound.up" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.compound.up" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail.compound.down&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Move the selected add-on one line down", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.compound.down" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.compound.down" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.history&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Tariff plan change history ", "tags": [ "pricelist" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PricelistHistoryElem" } } } } } } } } } }, "?func=pricelist.detail.up&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Move the selected add-on one line up", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.up" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.up" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.detail.down&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Move the selected add-on one line down", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.down" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.detail.down" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.change": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of tariff change rules", "tags": [ "pricelist" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PricelistChangeElem" } } } } } } } } } }, "?func=pricelist.change.resume&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable tariff change rule", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.change.resume" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.change.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.change.suspend&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable tariff change rule", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.change.suspend" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.change.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.change.rule&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of tariff change special rules", "tags": [ "pricelist" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PricelistChangeRuleElem" } } } } } } } } } }, "?func=pricelist.change.rule.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create tariff change special rule", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.change.rule.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistChangeRuleNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.change.rule.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=pricelist.change.rule.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit tariff change special rule", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.change.rule.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistChangeRule" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.change.rule.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.change.rule.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete tariff change special rule", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.change.rule.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.change.rule.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.reference": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of addon dependencies", "tags": [ "pricelist" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PricelistReferenceElem" } } } } } } } } } }, "?func=pricelist.reference.edit": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create addon dependency", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.reference.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistReferenceNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.reference.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=pricelist.reference.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit addon dependency", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.reference.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistReference" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.reference.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.reference.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete addon dependency", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.reference.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.reference.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelist.reference.clone&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Copy the selected dependency ", "tags": [ "pricelist" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.reference.clone" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistReferenceClone" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelist.reference.clone" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=itemtype": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of product types", "tags": [ "itemtype" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/ItemtypeElem" } } } } } } } } } }, "?func=itemtype.edit": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create product type", "tags": [ "itemtype" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "itemtype.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/ItemtypeNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "itemtype.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=itemtype.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit product type", "tags": [ "itemtype" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "itemtype.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Itemtype" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "itemtype.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=itemtype.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete product type", "tags": [ "itemtype" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "itemtype.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "itemtype.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=itemtype.up&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Move the selected product type one line up", "tags": [ "itemtype" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "itemtype.up" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "itemtype.up" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=itemtype.down&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Move the selected product type one line down", "tags": [ "itemtype" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "itemtype.down" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "itemtype.down" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelistgroup": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of pricelist groups", "tags": [ "pricelistgroup" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PricelistgroupElem" } } } } } } } } } }, "?func=pricelistgroup.edit": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create pricelist group", "tags": [ "pricelistgroup" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelistgroup.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PricelistgroupNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelistgroup.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=pricelistgroup.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit pricelist group", "tags": [ "pricelistgroup" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelistgroup.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Pricelistgroup" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelistgroup.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=pricelistgroup.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete pricelist group", "tags": [ "pricelistgroup" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelistgroup.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "pricelistgroup.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=promotion": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of promotions", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionElem" } } } } } } } } } }, "?func=promotion.edit": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create promotion", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PromotionNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=promotion.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit promotion", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Promotion" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=promotion.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete promotion", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=promotion.discount&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of promotion discounts", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscountElem" } } } } } } } } } }, "?func=promotion.discount.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create promotion discount", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.discount.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PromotionDiscountNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.discount.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=promotion.discount.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit promotion discount", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.discount.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PromotionDiscount" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.discount.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=promotion.discount.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete promotion discount", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.discount.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.discount.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=promotion.condition&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of promotion conditions", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionConditionElem" } } } } } } } } } }, "?func=promotion.condition.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create promotion condition", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.condition.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PromotionConditionNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.condition.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=promotion.condition.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit promotion condition", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.condition.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PromotionCondition" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.condition.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=promotion.condition.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete promotion condition", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.condition.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.condition.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=promotion.clone&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Copy the promotion", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.clone" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PromotionClone" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.clone" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=promotion.history&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Promotion change history", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionHistoryElem" } } } } } } } } } }, "?func=promotion.archived&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Promotions archive", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionArchivedElem" } } } } } } } } } }, "?func=promotion.promocode&plid={plid}&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of promocodes", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "plid", "schema": { "type": "int" }, "description": "Unique identifier of the parent element" }, { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionPromocodeElem" } } } } } } } } } }, "?func=promotion.promocode.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create promocode", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.promocode.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PromotionPromocodeNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.promocode.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=promotion.promocode.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit promocode", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.promocode.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PromotionPromocode" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.promocode.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=promotion.promocode.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete promocode", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.promocode.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.promocode.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=promocode.usage&plid={plid}&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Promo code usage", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "plid", "schema": { "type": "int" }, "description": "Unique identifier of the parent element" }, { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromocodeUsageElem" } } } } } } } } } }, "?func=promotion.coupon&plid={plid}&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of certificates", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "plid", "schema": { "type": "int" }, "description": "Unique identifier of the parent element" }, { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionCouponElem" } } } } } } } } } }, "?func=promotion.coupon.edit&plid={plid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Create certificate", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.coupon.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PromotionCouponNew" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.coupon.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "description": "Unique identificator", "example": "1" } } } } } } } } }, "?func=promotion.coupon.edit&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit certificate", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.coupon.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/PromotionCoupon" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.coupon.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=promotion.coupon.delete&plid={plid}&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete certificate", "tags": [ "promotion" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.coupon.delete" ] }, "plid": { "type": "int", "description": "Unique identifier of the parent element" }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "promotion.coupon.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=promotion.coupon.usage&plid={plid}&elid={elid}": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Certificate usage", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "plid", "schema": { "type": "int" }, "description": "Unique identifier of the parent element" }, { "in": "query", "name": "elid", "schema": { "type": "int" }, "description": "Unique element identifier" }, { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionCouponUsageElem" } } } } } } } } } }, "?func=promotion.discount.history": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Edit the selected discount", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscountHistoryElem" } } } } } } } } } }, "?func=promotion.condition.history": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Condition for participation in the promotion", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionConditionHistoryElem" } } } } } } } } } }, "?func=promotion.promocode.history": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Edit properties of the selected promo code", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionPromocodeHistoryElem" } } } } } } } } } }, "?func=promotion.coupon.history": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Certificate parameters", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionCouponHistoryElem" } } } } } } } } } }, "?func=promotion.promocode.usage": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Promo code usage", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionPromocodeUsageElem" } } } } } } } } } }, "?func=coupon.usage": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Use of certificates", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/CouponUsageElem" } } } } } } } } } }, "?func=cashback.usage": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "Cashback use", "tags": [ "promotion" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/CashbackUsageElem" } } } } } } } } } }, "?func=v2.addition.order.param&clicked_button=order": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Order service", "tags": [ "addition" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "v2.addition.order.param" ] }, "clicked_button": { "type": "string", "enum": [ "order" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/OrderParamV2" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "v2.addition.order.param" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=addition": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of modules", "tags": [ "addition" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionElem" } } } } } } } } } }, "?func=addition.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit module", "tags": [ "addition" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "addition.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Addition" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "addition.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=addition.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete module", "tags": [ "addition" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "addition.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "addition.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=addition.resume&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable module", "tags": [ "addition" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "addition.resume" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "addition.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=addition.suspend&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable module", "tags": [ "addition" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "addition.suspend" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "addition.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=v2.backupservice.order.param&clicked_button=order": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Order service", "tags": [ "backupservice" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "v2.backupservice.order.param" ] }, "clicked_button": { "type": "string", "enum": [ "order" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/OrderParamV2" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "v2.backupservice.order.param" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=backupservice": { "get": { "security": [ { "SessionAuth": [] } ], "summary": "List of services (backup)", "tags": [ "backupservice" ], "parameters": [ { "in": "query", "name": "out", "schema": { "$ref": "#/components/schemas/OutFormat" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "elem": { "type": "array", "items": { "$ref": "#/components/schemas/BackupserviceElem" } } } } } } } } } }, "?func=backupservice.edit&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Edit service (backup)", "tags": [ "backupservice" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "backupservice.edit" ] }, "sok": { "type": "string", "enum": [ "ok" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } }, { "$ref": "#/components/schemas/Backupservice" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "backupservice.edit" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=backupservice.delete&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Delete service (backup)", "tags": [ "backupservice" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "backupservice.delete" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "backupservice.delete" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=backupservice.resume&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Enable service (backup)", "tags": [ "backupservice" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "backupservice.resume" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "backupservice.resume" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=backupservice.suspend&elid={elid}": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Disable service (backup)", "tags": [ "backupservice" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "allOf": [ { "type": "object", "properties": { "func": { "type": "string", "enum": [ "backupservice.suspend" ] }, "elid": { "type": "int", "description": "Unique element identifier" }, "out": { "type": "string", "enum": [ "bjson" ], "default": "bjson" } } } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "func": { "type": "string", "enum": [ "backupservice.suspend" ] }, "ok": { "type": "boolean", "enum": [ true ] } } } } } } } } }, "?func=v2.certificate.order.param&clicked_button=order": { "post": { "security": [ { "SessionAuth": [] } ], "summary": "Order service", "tags": [ "certificate" ], "requestBody": { "content": { "application/x-www-form-urlencoded": {