{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ac999e0e-1554-46d2-a345-028506141bec","name":"phenix_Api","description":"<img src=\"https://phenixsoft.com/images/logos/logo-1.WebP\" alt=\"Phenix%20Accounting%20Systems%20API\">\n\nWhen a Phenix server has an active “DataService” service, a HTTP requests can be issued to the server to invoke specific methods.  \nThe most basic way would be with a GET request, with the following URL and no content in the message body:\n\n[http://host:port/api/rest/TPhenixApi/[MethodName]/[ParamValue]](http://host:port/api/rest/TPhenixApi/[MethodName]/[ParamValue])\n\n### **Parameters in the URL:**\n\n- ParamValue represents a slash (/) separated list of parameter values, which match up with the input parameters required by the server method being invoked.\n    \n- If the server method (function/procedure) has no input parameters, then nothing should follow the method name in the URL.\n    \n- Two slashes (//) in the portion of the URL representing the parameters values set the value of the parameter at that index to be an empty string.\n    \n- The values passed in this way must be encoded to be URL safe, which also includes encoding Unicode characters. Values with a JSON Object or JSON Array representation cannot be passed in this manner: they need to be passed in the body of the HTTP request, and the request type must be POST or PUT.\n    \n\n### Parameters in the Request Body\n\nIf you want to invoke a server method that has an input parameter not supported by a GET or DELETE request (for example, one that cannot be represented as a string, number, Boolean, or null) or if you simply want to pass in one or more parameters through the content of the request, then you need to use a POST or PUT request type.\n\n### Authentication\n\nThe Phenix server requires authentication, you will need to pass in your authentication information (user name and password) properly formatted in the 'Authorization' header in your request.  \nThis is only required, however, when you are not specifying a session ID in the request. The format of the value for the Authorization header is as follows:  \n`Basic base64(user:password)`Note that the string to base64-encode needs to be a single string representing the name and the password, with a colon between them.\n\n### Session Information\n\n**Please read this section carefully.**\n\nWhen invoking a server method to the Phenix server, it is essential to specify which session should be handled for the request.\n\nThere are two scenarios:\n\n1. **Initializing a New Session:**In this case, you need to create a new session initially, using the following method**[<code><b>http://host:port/api/rest/TPhenixApi/initialize/compid/brid/username/pwd<br></b></code>](http://host:port/api/rest/TPhenixApi/initialize/compid/brid/username/pwd)**This method will create a new session and return the session id which will be used in all future invocation.****The result will be like this:**`{\"result\":[{\"session\":\"xxxxx.xxxxxx.xxxxxx\",\"result\":\"success\"}]}`****Passing session id**  \n    Once you have the session ID, you must pass it in the 'Pragma' header of each additional request, with the value specified being in the format:  \n    `dssession=[session ID]`  \n    If at any time you receive a SessionExpired result from the server, you should clear the session ID you have stored, and allow the server to provide you with a new one by calling “initialize” again.\n    \n    **Closing Session**  \n    To close your session before it expires, perform a GET request with the following URL,[](http://host:port/api/rest/TPhenixApi/CloseSession/)making sure to also pass in the session ID in the Pragma header of the request, as mentioned above:  \n    [<code>http://host:port/api/rest/TPhenixApi/CloseSession/</code>](http://host:port/api/rest/TPhenixApi/CloseSession/)  \n    This will terminate the session with the provided ID, and return the following response text if successful (if unsuccessful, the SessionExpired message will be returned):  \n    `{\"result\":[true]}`\n    \n2. **Using an Existing Session Token:**  \n    In this scenario, you must pass the \"phenixtoken\" in the request header. To obtain a token, please contact our sales or support team.  \n    Keep in mind that in this scenario, you do not need to use the initialize or closeSession functions, nor do you need to pass the pragma header in the request.\n    \n\n### Some Phenix Principles!\n\n#### Transaction Log Table\n\nEvery activity can the user do in Phenix, is recorded.  \nSo, when the user adds an item or a class all this information is saved in transaction log table.  \nTherefore, when you need to query about the new inserted items or classes..., you have to pass the last transaction log id that you have.  \nBecause of that in the first time, when you will ask our service to give you the items or the classes, the result will contain the `transaction_log_id` for the last record in the transaction log table. In next time when you will ask the service then you have to pass this id, and it will return all new items since that id and it will return a new `transaction_log_id` that you have to save in somewhere to reuse it in the next call.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"36496655","team":6305002,"collectionId":"ac999e0e-1554-46d2-a345-028506141bec","publishedId":"2sA3drKFXN","public":true,"publicUrl":"https://api.phenixsoft.com","privateUrl":"https://go.postman.co/documentation/36496655-ac999e0e-1554-46d2-a345-028506141bec","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Explore the Phenix API Documentation for seamless integration with our Basic ERP System. "},{"name":"title","value":"Phenix API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/2f64ea59-e4e3-472b-8617-16e19866c071/bG9nb182MDB4NDAwLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/2f64ea59-e4e3-472b-8617-16e19866c071/bG9nb182MDB4NDAwLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-09-09T06:32:06.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Phenix API Documentation","description":"Explore the Phenix API Documentation for seamless integration with our Basic ERP System. "},"logos":{"logoLight":"https://content.pstmn.io/2f64ea59-e4e3-472b-8617-16e19866c071/bG9nb182MDB4NDAwLnBuZw==","logoDark":"https://content.pstmn.io/2f64ea59-e4e3-472b-8617-16e19866c071/bG9nb182MDB4NDAwLnBuZw=="}},"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/7549218e6f85abf1942467fefc308e24adf7f36cbd2776b5ce0d048656ee344d","favicon":"https://phenixsoft.com/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.phenixsoft.com/view/metadata/2sA3drKFXN"}