{"id":22514685,"url":"https://github.com/cityssm/node-dynamics-gp","last_synced_at":"2025-08-03T16:31:11.362Z","repository":{"id":103175129,"uuid":"608293542","full_name":"cityssm/node-dynamics-gp","owner":"cityssm","description":"Read only inquiries into Microsoft Dynamics GP with a SQL Server connection.","archived":false,"fork":false,"pushed_at":"2024-11-13T18:21:33.000Z","size":424,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-13T18:38:15.896Z","etag":null,"topics":["dynamics-gp","microsoft-dynamics","microsoft-dynamics-gp"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@cityssm/dynamics-gp","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cityssm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-01T18:07:37.000Z","updated_at":"2024-11-13T18:18:25.000Z","dependencies_parsed_at":"2023-12-01T19:30:24.705Z","dependency_job_id":"466ab6b7-8c39-4518-8d81-e85fba635172","html_url":"https://github.com/cityssm/node-dynamics-gp","commit_stats":{"total_commits":38,"total_committers":2,"mean_commits":19.0,"dds":"0.052631578947368474","last_synced_commit":"54d755c642d18a36d368927ba0d3d8d21b56f24e"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cityssm%2Fnode-dynamics-gp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cityssm%2Fnode-dynamics-gp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cityssm%2Fnode-dynamics-gp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cityssm%2Fnode-dynamics-gp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cityssm","download_url":"https://codeload.github.com/cityssm/node-dynamics-gp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228553635,"owners_count":17936016,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dynamics-gp","microsoft-dynamics","microsoft-dynamics-gp"],"created_at":"2024-12-07T03:20:28.336Z","updated_at":"2025-08-03T16:31:11.342Z","avatar_url":"https://github.com/cityssm.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Node Dynamics GP\n\n[![npm (scoped)](https://img.shields.io/npm/v/@cityssm/dynamics-gp)](https://www.npmjs.com/package/@cityssm/dynamics-gp)\n[![codecov](https://codecov.io/gh/cityssm/node-dynamics-gp/branch/main/graph/badge.svg?token=K2D0W6D1LN)](https://codecov.io/gh/cityssm/node-dynamics-gp)\n[![Build Status](https://github.com/cityssm/node-dynamics-gp/actions/workflows/coverage.yml/badge.svg)](https://github.com/cityssm/node-dynamics-gp/actions/workflows/coverage.yml)\n[![DeepSource](https://app.deepsource.com/gh/cityssm/node-dynamics-gp.svg/?label=active+issues\u0026show_trend=true\u0026token=8upUaCFLWbSvxfWIhbeiD2_E)](https://app.deepsource.com/gh/cityssm/node-dynamics-gp/)\n\n_Read only inquiries into Microsoft Dynamics GP using a SQL Server connection._\n\nThe purpose of this project to make it easy to incorporate **on prem** Dynamics GP data\ninto custom business applications. It connects to the underlying SQL Server directly,\nand returns data in easy-to-use Javascript objects.\n\nBuilt to validate transactions linked from the City of Sault Ste. Marie's\n[Sunrise CMS](https://github.com/cityssm/sunrise-cms).\n\n_Tested with Microsoft Dynamics GP 2018._\n\n## Features\n\n- 🙌 **TypeScript types.** Easy to get started.\n\n- 🙌 **Temporary caching** to reduce database hits and function return times.\n\n- 🙌 **All whitespace trimmed** from the end of the `char` data. Strings are ready to use!\n\n- 🙌 **Consistent and clear field names.** For example:\n  - `PRIMVNDR` becomes `primaryVendorId`\n  - `PHNUMBR2` becomes `phoneNumber2`\n  - `PHONE3` becomes `phoneNumber3`\n\n### Good Use Cases\n\n- ✔️ Validating a corresponding receipt number was properly entered.\n\n- ✔️ Displaying the status of an outstanding invoice in a business application.\n\n- ✔️ Populating contact fields based on customer information.\n\n### Not So Good Use Cases\n\n- ❌ Reporting on all of the inventory items at a specific location.\n  _Use a SmartList instead._\n\n- ❌ Modifying Dynamics GP data.\n  _Use Dynamics GP._\n\n## Installation\n\n```sh\nnpm install @cityssm/dynamics-gp\n```\n\n## Dynamics GP Functions\n\n```javascript\nimport { DynamicsGP } from '@cityssm/dynamics-gp'\n\nconst gp = new DynamicsGP(mssqlConfig)\n\nconst account = await gp.getAccountByAccountIndex(123)\n\nconst customer = await gp.getCustomerByCustomerNumber('CUST0001')\n\nconst invoice = await gp.getInvoiceByInvoiceNumber('INV00000002')\n\nconst item = await gp.getItemByItemNumber('01-0001-00001')\n\nconst vendor = await gp.getVendorByVendorId('VEND002')\n```\n\n## Diamond-Specific GP Functions\n\nThe functions below query Dynamics GP tables with extensions from\n[Diamond Municipal Solutions](https://diamondmunicipal.com/).\n\n```javascript\nconst cashReceipt = await gp.getDiamondCashReceiptByDocumentNumber('123456')\n\nconst invoice = await gp.getDiamondExtendedInvoiceByInvoiceNumber(invoiceNumber)\n```\n\n## Contributions\n\nIs a field you need missing? An entire table?\n[Create an issue](https://github.com/cityssm/node-dynamics-gp/issues) with your request,\nor better yet, [submit a pull request](https://github.com/cityssm/node-dynamics-gp/pulls)\nimplementing the feature you need!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcityssm%2Fnode-dynamics-gp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcityssm%2Fnode-dynamics-gp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcityssm%2Fnode-dynamics-gp/lists"}