PHPackages ayvazyan10/armsoft - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [HTTP & Networking](/categories/http) 4. / 5. ayvazyan10/armsoft ActiveLibrary[HTTP & Networking](/categories/http) ayvazyan10/armsoft ================== This Laravel package allows you to interact with the ArmSoft API easily v1.1.2(3y ago)45MITPHPPHP >=7.1 Since Apr 24Pushed 3y ago1 watchersCompare [ Source](https://github.com/ayvazyan10/ArmSoft)[ Packagist](https://packagist.org/packages/ayvazyan10/armsoft)[ Docs](https://github.com/ayvazyan10/armsoft)[ RSS](/packages/ayvazyan10-armsoft/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (1)Dependencies (3)Versions (2)Used By (0) ArmSoft Laravel Package ======================= [](#armsoft-laravel-package) This Laravel package allows you to interact with the ArmSoft API easily, providing methods for authentication and working with various endpoints such as Goods, GoodsRem, PriceList, DocumentsJournal, and MTBill. - Authenticate and refresh access token - Get goods, goodsRems, price lists, documents journal and MTBill from ArmSoft API - Send data for creating an invoice #### Notes: [](#notes) - This package is currently in beta version. - The ArmSoft API is still in development and may change without notice. - I will update the package as soon as they give me more information. [![Buy me a coffee](https://camo.githubusercontent.com/aed849270fd025c7733a6dcedd69be887c73ea55a6dae5c9a4c3b1431c16c62c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4275792532306d6525323061253230636f666665652d446f6e6174652d79656c6c6f773f7374796c653d666f722d7468652d6261646765266c6f676f3d6275796d6561636f66666565)](https://www.buymeacoffee.com/ayvazyan403) [![Image Description](https://camo.githubusercontent.com/98d4df6a3e58f071109dec76ad3c32fbc0ab5f1635293a3b711df3a0b8a28453/68747470733a2f2f7765646f2e64657369676e2f6c6f676f2d626c61636b2e737667)](https://camo.githubusercontent.com/98d4df6a3e58f071109dec76ad3c32fbc0ab5f1635293a3b711df3a0b8a28453/68747470733a2f2f7765646f2e64657369676e2f6c6f676f2d626c61636b2e737667) ### 🚀 Installation [](#-installation) #### You can install the package using Composer: [](#you-can-install-the-package-using-composer) ``` composer require ayvazyan10/armsoft ``` #### Release the configuration file and database migration. [](#release-the-configuration-file-and-database-migration) First, you need to configure the package with your ArmSoft API credentials. You can do this by publishing the configuration file: ``` php artisan vendor:publish --provider="Ayvazyan10\ArmSoft\ArmSoftServiceProvider" ``` Then, fill in the config/armsoft.php file with your ArmSoft API credentials and settings. ### ⚙️ Configuration [](#️-configuration) After publishing the configuration file, you should set your ArmSoft credentials/options in the config/armsoft.php file or in your .env file: - ARM\_SOFT\_CLIENT\_ID - Your ArmSoft API client ID. - ARM\_SOFT\_SECRET - Your ArmSoft API secret key. - ARM\_SOFT\_DB\_ID - The ID of your ArmSoft database. ``` ARM_SOFT_CLIENT_ID=your_client_id ARM_SOFT_SECRET=your_secret ARM_SOFT_DB_ID=your_db_id ``` or provide it in config/armsoft.php ``` /** * Configuration for the ArmSoft API package. * * Note: This package is currently in beta version and the ArmSoft API is not yet finished. */ return [ // Required: Your ArmSoft client ID 'ClientId' => env('ARM_SOFT_CLIENT_ID', '00000000-0000-0000-0000-000000000000'), // Required: Your ArmSoft client secret 'Secret' => env('ARM_SOFT_SECRET', '000000000000'), // Required: The ID of your ArmSoft database 'DBId' => env('ARM_SOFT_DB_ID', '00000'), // Optional: The price type to use for price-related API calls (01 - wholesale, 02 - retail, 03 - purchase price) 'priceType' => '02', // Optional: The language to use in API responses 'language' => 'en-US,en;q=0.5', // Optional: Additional settings to pass to the ArmSoft API 'settings' => [ 'ShowProgress' => false, 'ShowColumns' => false, ], ]; ``` ### ⚡ All Methods [](#-all-methods) Please note that this only contains method signatures without the implementation details. ``` // getGoods final public function getGoods(string $date = null): ?array { /*...*/ } // getGoodsRem final public function getGoodsRem(string $date = null, string $mtcode = null): ?array { /*...*/ } // getPrices final public function getPrices(string $date = null, string $mtcode = null, string $pricetypes = null): ?array { /*...*/ } // getDocumentsJournal final public function getDocumentsJournal(string $dateBegin = null, string $dateEnd = null): ?array { /*...*/ } // getMTbill final public function getMTbill(mixed $guid): mixed { /*...*/ } // setMTbill final public function setMTbill(array $data): mixed { /*...*/ } ``` ### 📚 Usage [](#-usage) Here is an example of how to use the ArmSoft facade or helper in your Laravel application: ``` use ayvazyan10\ArmSoft\Facades\ArmSoft; // with facade $goods = ArmSoft::getGoods('2023-04-24'); // or use the helper function $goods = armsoft()->getGoods('2023-04-24'); // or ArmSoft class directly use ayvazyan10\ArmSoft\ArmSoft; $armSoft = new ArmSoft(); $goods = $armSoft->getGoods('2023-04-24'); ``` ### 📖 Examples & Explanations [](#-examples--explanations) Below are some examples of how you could use these methods with a Facade: In this example, Armsoft is a Facade that allows you to access the Armsoft API using the methods provided by the Armsoft class. The Facade is registered in the app.php config file and bound to the Armsoft class using the Laravel service container. ``` // In your controller or anywhere else use ayvazyan10\ArmSoft\Facades\ArmSoft; public function myMethod() { // Get the goods for today $goods = Armsoft::getGoods(); // Get the goods rem for a specific MTCode $goodsRem = Armsoft::getGoodsRem(null, 'MTCode123'); // Get the prices for a specific date and MTCode $prices = Armsoft::getPrices('2023-04-24', 'MTCode123'); // Get the documents journal for a date range $documentsJournal = Armsoft::getDocumentsJournal('2023-04-01', '2023-04-30'); // Get an MTBill by its GUID $mtBill = Armsoft::getMTbill('MTBill123'); // Create an MTBill with some data $newMTBill = Armsoft::setMTbill([ 'MTCode' => 'MTCode123', 'Description' => 'Some description', // ... ]); } ``` You can use the Facade to call the getGoods(), getGoodsRem(), getPrices(), getDocumentsJournal(), getMTbill(), and setMTbill() methods provided by the Armsoft class. You can pass in any necessary parameters to these methods, as shown in the example above. If an error occurs while calling the API, the methods will throw an Exception with a descriptive error message. ### Example with products import [](#example-with-products-import) ``` // in your controller or anywhere else // in this example we using helper /** * Products Import from ArmSoft API. * * @throws Exception */ public function importGoods() { $items = armsoft()->getGoods(now()->format('Y-m-d')); if (count($items["rows"]) === 0) { throw new Exception('ArmSoft API error: no products'); } foreach ($items["rows"] as $key => $item) { if (((int)$key + 1) % 2 === 0) { continue; } $priceRequest = armsoft()->getPrices(null, $item["MTCode"], config('armsoft.PriceType', '02')); $price = !empty(current($priceRequest["rows"])["Price"]) ? current($priceRequest["rows"])["Price"] : 0; $stockRequest = armsoft()->getGoodsRem(null, $item["MTCode"]); $stock = !empty(current($stockRequest["rows"])["Qty"]) ? current($stockRequest["rows"])["Qty"] : 0; $productData = [ 'armsoft_title' => $item["FullCaption"] 'category_id' => $item["Group"], 'MTCode' => $item["MTCode"], 'discount' => $item["Discount"], 'stock' => intval($stock), 'price' => $price // ... fields ]; try { YourModel::where('MTCode', $item["MTCode"])->updateOrCreate([ 'MTCode' => $item["MTCode"] ], $productData); } catch (Exception $e) { return $e->getMessage(); } } return redirect()->back(); } ``` ### Detailed explanation of each method: [](#detailed-explanation-of-each-method) getGoods(string $date = null): ?array: This method returns the goods with the given RemDate. You can pass in a date string in yyyy-mm-dd format to retrieve goods for a specific date. If no date is provided, the method will retrieve goods for the current date. The method returns an array of goods, or null if no goods are found. getGoodsRem(string $date = null, string $mtcode = null): ?array: This method returns the GoodsRem with the given RemDate and single one if MTCode provided. You can pass in a date string in yyyy-mm-dd format to retrieve goods rem for a specific date. If no date is provided, the method will retrieve goods rem for the current date. You can also pass in a unique MTCode to retrieve a specific GoodsRem. The method returns an array of GoodsRem, or null if no GoodsRem are found. getPrices(string $date = null, string $mtcode = null, string $pricetypes = null): ?array: This method returns the PriceList with the given RemDate and single one if MTCode|PriceType provided. You can pass in a date string in yyyy-mm-dd format to retrieve prices for a specific date. If no date is provided, the method will retrieve prices for the current date. You can also pass in a unique MTCode and/or price types to retrieve specific prices. The method returns an array of prices, or null if no prices are found. getDocumentsJournal(string $dateBegin = null, string $dateEnd = null): ?array: This method returns the DocumentsJournal with the given RemDate and single one if MTCode|PriceType provided. You can pass in a date range to retrieve documents for a specific range. If no date range is provided, the method will retrieve all documents. The method returns an array of documents, or null if no documents are found. getMTbill(mixed $guid): mixed: This method returns an MTBill with the given GUID. You can pass in a GUID string to retrieve a specific MTBill. The method returns an MTBill object, or null if no MTBill is found. setMTbill(array $data): mixed: This method sends MTBill data for creating an invoice. You can pass in an array of MTBill data to create a new invoice. The method returns the created MTBill object, or null if the MTBill could not be created. ### All of these methods may throw an Exception if an error occurs while calling the ArmSoft API. [](#all-of-these-methods-may-throw-an-exception-if-an-error-occurs-while-calling-the-armsoft-api) #### You can catch it like this [](#you-can-catch-it-like-this) ``` // in your controller method or anywhere else try { $mtbill = ArmSoft::getMTbill('your_guid_here'); } catch (Exception $e) { return $e->getMessage(); } // Perform actions with $mtbill or $response data ``` Contributing ------------ [](#contributing) Please see [contributing.md](contributing.md) for details and a todolist. Security -------- [](#security) If you discover any security related issues, please email instead of using the issue tracker. Author ------ [](#author) - [Razmik Ayvazyan](https://github.com/ayvazyan10) License ------- [](#license) MIT. Please see the [license file](license.md) for more information. ### Health Score 20 — LowBetter than 14% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity8 Limited adoption so far Community7 Small or concentrated contributor base Maturity39 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 1110d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/962a9665d168b42630d6c6e81eeee81993ee407056be00b14ea07074179ac65d?d=identicon)[ayvazyan10](/maintainers/ayvazyan10) --- Top Contributors [![ayvazyan10](https://avatars.githubusercontent.com/u/79054971?v=4)](https://github.com/ayvazyan10 "ayvazyan10 (15 commits)") --- Tags apilaravelrestArmSoft ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/ayvazyan10-armsoft/health.svg) ``` [![Health](https://phpackages.com/badges/ayvazyan10-armsoft/health.svg)](https://phpackages.com/packages/ayvazyan10-armsoft) ``` ### Alternatives [api-platform/laravel API Platform support for Laravel 59126.4k5](/packages/api-platform-laravel)[illuminatech/data-provider Allows easy build for DB queries from API requests 4413.3k](/packages/illuminatech-data-provider)[laragear/api-manager Manage multiple REST servers to make requests in few lines and fluently. 161.8k](/packages/laragear-api-manager) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)