{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"65bfaab6-4bf4-45e6-9748-8211a03d7b79","name":"Smartup API Documentation","description":"#### Overview:\n\n---\n\n> This is official \n \n\n**Smartup** - ERP-system for automating the work of sales agents, sales department, accounting, warehouse, logistics. It is a cloud-based solution for distribution, trade marketing, wholesale and retail management.\n\nSmartup APIs are used to build integration solutions with external systems. \nThe documentation details the data model used by Smartup to exchange information with external systems, as well as the principles of API operation.\n\nAPI operates with such basic concepts as: \n**document_id -** is a figurative designation of such objects/records as _movement_id, stocktaking_id, writeoff_id, return_id, input_id, deal_id_. \n**external_id -** is an identifier of objects/records assigned by external system.\n\nAll requests must be executed in UTF-8 encoding. The number of requests is not limited.\n\nAPI works with `HTTPS` protocol as well as uses **JSON** and **XML** data formats. All the requests and responses are based on `HTTP` methods.\n\n### API Limitations:\n\nTo ensure system stability and performance, the following limitations are in place:\n\n- **Request Limits:** Each company has a daily limit on the number of API requests.\n \n - **References:** 100 requests per day\n \n - **Infrequently used documents:** 300 requests per day\n \n - **Frequently used documents:** 500 requests per day\n \n- **Data Access Limits:**\n \n - **Data Period:** You can only request data from the last 7 days from the current date\n \n- **Limits on the Number of Objects in Requests:**\n \n - **Data Import:** Each request to import data is limited to a maximum of 5000 objects\n \n\nThe \"Document\" responses include detailed information about the current limitations of the company\n\n``` json\n \"limits\": {\n \"has_limit\": \"\",\n \"limit_quant\": \"\".\n \"object_count\": \"\",\n \"day_range_limit\": \"\",\n \"request_quant\": \"\".\n \"left_limit_quant\": \"\"\n }\n\n ```\n\n**Description of response parameters**\n\n| Key | **Data type** | Description |\n| --- | --- | --- |\n| limits | array | An array with data about companies' limits |\n| has_limit | string | Indicates whether the company has a limit set (\"Y\" / \"N\") |\n| limit_quant | number | Maximum number of requests allowed in the set period |\n| object_count | number | Maximum number of objects allowed in a single request |\n| day_range_limit | number | Maximum number of days for which data can be requested |\n| request_quant | number | Current number of requests used in the current period |\n| left_limit_quant | number | Number of remaining requests before reaching the limit |\n\n### Authentication:\n\n**Authorization** in the Smartup system takes place according to the **Basic Auth principle**.\n\n**Basic** - the simplest scheme, in which the user's login and password are passed in the **Authorization header** in unencrypted form (_base64-encoded_). However, when using the `HTTPS` (HTTP over SSL) protocol, it is relatively secure.\n\n\n\n### Terms bvc\n\n| Name | Description |\n| --- | --- |\n| Single organization | The organization, where all the appropriate entities can be adjusted. There is no access to other single organizations. |\n| Head organization | The administrative organization, where all the single organizations can be adjusted, which means there is access to manage other single organizations. |\n\n### Authorization\n\n| Parameter | Data type | Required | Description |\n| --- | --- | --- | --- |\n| username | string | yes | Login, that is used for authorization in Smartup X |\n| password | string | yes | Password, that is used for authorization in Smartup X |\n\n### Headers\n\n| Key | Value | Description | Example |\n| --- | --- | --- | --- |\n| project_code | | Used to identify the project you are working on. A unique \"trade\" or other project identifier. | The project code specifies which project it refers to. Several projects use Smartup. To them \"trade\", \"anor\", \"clinic\", \"telecom\" ... |\n| filial_id | | The ID of Single Organization or Head Organization that is used to determine the organization you are going to work on. | \\- In case you choose `filial_id` of single organization, then all the requests will be based on chosen organization.
\\- In case you choose `filial_id` of Head organization, then all the requests will be based on `filial_code` parameter of the request (If no `filial_code` was set, then all the requests will show the info by all organizations. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"38039337","collectionId":"65bfaab6-4bf4-45e6-9748-8211a03d7b79","publishedId":"2sAXxP8Xzx","public":true,"publicUrl":"https://api.greenwhite.uz","privateUrl":"https://go.postman.co/documentation/38039337-65bfaab6-4bf4-45e6-9748-8211a03d7b79","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.4","publishDate":"2024-10-09T11:08:12.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://greenwhite.uz/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api.greenwhite.uz/view/metadata/2sAXxP8Xzx"}