ubiquiti-app / ucrm-plugins

Plugins for UCRM - Complete WISP Management Platform

UCRM-plugins

Plugins are open-source programs that extend the functionality of UCRM. These plugins will enable your UCRM to import payments, integrate with another accounting software, cooperate with 3rd party HW and tools, view or create custom reports, modify all the UCRM data in a batch, etc. Read more.

UCRM plugins are compatible with UCRM 2.10.0+

How does it work?

• Find the plugin you need and download its ZIP archive.
• Upload the ZIP archive in UCRM (System > Plugins).
• Then, enable the plugin and configure its settings.
• That's it, let UCRM run the plugin repeatedly or click to execute it on demand.

List of available plugins

Name	Description
SMS Gateway Integration	Integrates Twilio SMS gateway which enables UCRM to send SMS to clients triggered by custom defined events, e.g. client's service gets suspended.
QuickBooks Online	Sync financial data from UCRM into QB Online
FIO CZ	Automatic payments import and matching with clients - from WISP's FIO bank account
Client Signup	Enables any visitor to register as a new client through a public web form
KMZ Map	Provides a frontend Google Map for clients to view tower coverage.
Invoice CSV Export	Configurable export of invoices into CSV, can be used for a manual export to 3rd party accounting tools.
Revenue Report	Revenue report grouped by products or services, shown under the Reporting main menu section.
Facturas Argentina AFIP	Plugin para obtener CAE (Facturacion electronica) en Argentina

Plugins / API scripts from other sources

• Client Signup Extended - Extended version of Client Signup Plugin
• Notification Plugin - Extended UCRM's notification system. More event-triggered emails sent to UCRM administrators.
• UCRM FreeRadius - pulls the mac address and package from ucrm and push the information into free radius database

How can I contribute?

• These plugins are under MIT license enabling anyone to contribute any upgrades to existing plugins or create whole new ones.
• Propose any Pull Request in this repository.
• See the documentation below.

Developer documentation

Developer documentation for creating UCRM plugins can be found in docs/index.md

Disclaimer

The software is provided "as is", without any warranty of any kind. Read more in the licence

ucrm-plugins's Issues

No route found - UCRM Client Signup

States are missing from the drop down after choosing a country

error in console
No route found for "GET /crm/api/v1.0/countries/249/states""

Error in Log

Invoice ID: 15 needs to be exported, can you tell me what this means. The plugin is not exporting clients, invoices or payments.

Add default country, in UCRM Client Signup (UCMR 1.3.1)

Could add default country option.
Thanks.

Plugins / Mikrotik RouterOS - suspension Error

After the activate the plugin (in green) this was disconnect in gray, and not work, some idea? help me please

Mikrotik RouterOS - suspension Version 1.1.0 Author Ubiquiti Inc.
UNMS 1.2.6

MikrotikQueue Sync plugin-no IP address set

Hi, I would like what this means in my log

Synchronization started Service ID: 2 has no ip address set

API Documentation

Any chance someone on the team can compile a table of the different links to the Apiary Docs for each version. And then maybe include it in the README.md?

So far, there are the following I have found at docs.apiary.io:

• unmscrm
• ucrmbeta
• ucrmdev
• ucrm

I am currently referencing multiples of the above while coding against UCRM 3.1.0-beta1 and not sure which should be the correct docs.

Much appreciated.

Mikrotik Queue Sync - Synchronization problem

I get this error

Synchronization started
Service ID: 324 has no ip address set
Service ID: 329 has no ip address set
Service ID: 335 has no ip address set
Service ID: 338 has no ip address set

the funny thing is that the service ID only reaches 290 and I don't know why

Greetings

Logging

Anyone know how/where are request/response logs? I am trying to tie payments to invoices but everytime I add 'line' to the payment request I get

[error] Payment ID: xxx export failed with error It is not possible to parse QB error: Object Not FoundObject Not Found : Something you're trying to use has been made inactive. Check the fields with accounts, customers, items, vendors or employees..

I verified the customer id, the invoice id, the amount etc and cannot find anything wrong. I do not find logs however that could help me resolve this issue.

TIA

Zip File Empty

Looks like an empty zip file has been uploaded on the last commit on or about Jan 4, 2019

Mikrotik Sync Plugin

Fatal error: Uncaught Ubnt\UcrmPluginSdk\Exception\ConfigurationException: Missing value in plugin configuration. in /data/ucrm/data/plugins/mkt-queue-sync/classes/Synchronizer.php:93 Stack trace: #0 /data/ucrm/data/plugins/mkt-queue-sync/public.php(34): MikrotikQueueSync\Synchronizer->sync() #1 /data/ucrm/data/plugins/mkt-queue-sync/public.php(51): {closure}() #2 /usr/src/ucrm/web/_plugins/mkt-queue-sync/public.php(3): require_once('/data/ucrm/data...') #3 {main} thrown in /data/ucrm/data/plugins/mkt-queue-sync/classes/Synchronizer.php on line 93

No Account Numbers in Quickbooks

My Quickbooks does not use Account Numbers, the accounts only have a name.

How do I assign the Income Account Number in the Plugin setup if I have no Account Numbers in Quickbooks?

Note, my customers are syncing nicely :-)

Plugin for Regular QuickBooks desktop integration great plugin though

hi great plugin but some of us or our managers are hesitant to pay for cloud accounting as it exposes our financial dealings is it possible to make a plugin that exports information for QuickBooks desktop or an intermediary that converts the QuickBooks cloud export to QuickBooks desktop format to be ingested by QuickBooks desktop thanks

MikroTik Suspention plugin-No logs showing

Since there are no logs showing I can not verify if the plugin does work with Mikrotik. Is there any way too to confirm that the MikroTik received the settings by seeing what it should've changed.

Dropbox plugin has no file limitation and manually deleting doesn't sync

I'm really happy about the reintroduced Dropbox backup file syncing. I don't have a lot of Dropbox space so I was wishing the plugin had a feature to limit how many files were stored.

Since it doesn't I decided to deal with it myself. I created a cron job that deletes any file in the backup directory that is older than 3 days. It works, but Dropbox does not sync the delete action.

Also, there must be some index somewhere because the UNMS web UI still lists the deleted backup files as available for download or to restore. But if I try to download any backup that my cron job has deleted it errors with "file not found" of course because it's gone.

Best fix would be to add a file count limit feature native in UNMS.
Next best would be to get Dropbox to sync the delete actions

Crutch at the moment is to keep a cron job active on one of my "always online" computers to delete (and properly sync) the files older than 3 days. The only thing left is the indexes in UNMS that I have to manually delete from time to time.

crontab line:
0 0 * * * root find /home/unms/data/unms-backups/backups -maxdepth 1 -type f -mtime +2 -exec rm -f {} ;

All invoices syncing as $1 to QB.

Hey,

For some reason all invoices that get synced over are coming up in QB as $1.00. Everything else is correct.

mikrotik access port

am using mikrotik on a diffrent port can you provide ways os setting it up

like 192.168.1.20:67

MikroTik Queue Sync Pro Contact?

How can I go about inquiring about the PRO version? I don't see any contact information in the repo. Also, will the PRO version work in the hosted UCRM/UISP, or just self-hosted?

Free version works great, but looking for suspension :) I very much appreciate the work done on this plug-in.

plugin barely works in 1.1.2

In UNMS 1.1.2 this plugin (v2.2.1) has basically stopped working properly. It will push about 8 queues in before finishing, it sees a lot of false 'missing' IPs.

Tested against 3 different routers.
Configuration seems correct in that it does put a few queues in within the network range
UNMS networks to monitor does have all customer subnets in it
mikrotik lots show api login AND logout.

plugin logs say
Synchronization started
Service ID: x has not IP address set
...
Synchronization correctly ended

There should be about 150 queues created. Only 8 are, and if I delete them those exact same ones get created again.
Only 12 missing IP warnings shown leaving a lot of completely missed customers.

Having become reliant on this plugin, really sucks to have it not working properly.

VOID, DRAFT, and PROFORMA invoices should never be exported to QBO

DRAFT, VOID, and Proforma invoices are being sent to QBO and should not be. This messes up an accounting system.

Error sync

Starting backup synchronization. (2020-11-07T12:03:01-04:00)
Uploaded file "unms-backup-20201106-2138_64c46697-9437-40e5-8eb0-abc5f4e57a76.unms". (2020-11-07T12:03:06-04:00)
Uploaded file "unms-backup-20201107-0228_0c5b3663-1335-4959-8aa3-c23498a84929.unms". (2020-11-07T12:03:07-04:00)
Uploaded file "unms-backup-20201107-0400_9d5eefc4-80de-4b1a-8188-c03cd4382d99.unms". (2020-11-07T12:03:09-04:00)
ERROR: (2020-11-07T12:03:09-04:00)
Finished backup synchronization. (2020-11-07T12:03:09-04:00)
Starting backup synchronization. (2020-11-07T12:12:01-04:00)
Uploaded file "unms-backup-20201106-2138_64c46697-9437-40e5-8eb0-abc5f4e57a76.unms". (2020-11-07T12:12:06-04:00)
Uploaded file "unms-backup-20201107-0228_0c5b3663-1335-4959-8aa3-c23498a84929.unms". (2020-11-07T12:12:07-04:00)
Uploaded file "unms-backup-20201107-0400_9d5eefc4-80de-4b1a-8188-c03cd4382d99.unms". (2020-11-07T12:12:09-04:00)
ERROR: (2020-11-07T12:12:09-04:00)
Finished backup synchronization. (2020-11-07T12:12:09-04:00)
Starting backup synchronization. (2020-11-07T12:16:01-04:00)
Uploaded file "unms-backup-20201106-2138_64c46697-9437-40e5-8eb0-abc5f4e57a76.unms". (2020-11-07T12:16:06-04:00)
Uploaded file "unms-backup-20201107-0228_0c5b3663-1335-4959-8aa3-c23498a84929.unms". (2020-11-07T12:16:07-04:00)
Uploaded file "unms-backup-20201107-0400_9d5eefc4-80de-4b1a-8188-c03cd4382d99.unms". (2020-11-07T12:16:09-04:00)
ERROR: (2020-11-07T12:16:09-04:00)
Finished backup synchronization. (2020-11-07T12:16:09-04:00)
Starting backup synchronization. (2020-11-07T14:00:05-04:00)
Uploaded file "unms-backup-20201106-2138_64c46697-9437-40e5-8eb0-abc5f4e57a76.unms". (2020-11-07T14:00:10-04:00)
Uploaded file "unms-backup-20201107-0228_0c5b3663-1335-4959-8aa3-c23498a84929.unms". (2020-11-07T14:00:11-04:00)
Uploaded file "unms-backup-20201107-0400_9d5eefc4-80de-4b1a-8188-c03cd4382d99.unms". (2020-11-07T14:00:13-04:00)
ERROR: (2020-11-07T14:00:13-04:00)
Finished backup synchronization. (2020-11-07T14:00:13-04:00)

two plugins, same purpose?

What's the difference here between MKT Queue Sync and RouterOS packet manager? Documentation on RouterOS packet manager is basically zero, but looking at the code it appears to do the same thing?

@csylos and @janprochazkacz any comments?

Fio can not import data

Hi,
Im not posible solve issue in UNMS v 1.0.0-alpha.5 with Fio bank paymant impor v1.1.4 every time it crashed on same thinks. Can you help me please?

[2019-06-12 8:51:01.238917] [info] CLI process started
[2019-06-12 8:51:02.212853] [info] New incoming transactions found: XX
[2019-06-12 8:51:02.212979] [info] Processing transaction XXXXXXXXXXX.
[2019-06-12 8:51:02.483071] [warning] Multiple matching results found for transaction XXXXXXXXXXX.
[2019-06-12 8:51:02.483243] [info] Not matched, importing as unattached
[2019-06-12 8:51:02.526628] [error] Error for request http://localhost/crm/api/v1.0/payments. HTTP error (422): {"code":422,"message":"Validation failed.","errors":{"method":["This field is not allowed."]}}
[2019-06-12 8:51:02.528181] [info] CLI process ended, wall time: 1.2890949249268 sec

Never delete

I suggest removing "Remove entity from QB when the related entity is deleted in UCRM" from future plans. One should never remove an entry from an accounting system, ever.

How to call toast notification from plugin?

I want to call a toast notification after any task. How can I do that?

Plugin Settings

At least as of UNMS 3.0.2, when saving changes to Plugin Settings, file upload fields are cleared.

Steps to reproduce:

1. Include a configuration item in the manifest.json with type "type: file" and "required: 0".
2. In Plugin Settings, upload a file and save.
3. Everything is as it should be.
4. Make any changes (or even none) in Plugin Settings and save again.
5. The file is now missing from the UI, value is null in data/config.json. File does remain in data/files/.

QBO Does not apply discounts

If a customer receives a discount, the plugin does not send it to QBO.

Fio bank payment import not working for Slovak FIO

Hi, i have Slovak FIO bank account. I generated token but its not working. In plugin files i see that its connecting to Czech FIO API. Could be Slovak FIO API URL added as well?

Mikrotik Queue Sync Plugin

I am trying to remove the Mikrotik Queue sync plugin, i have disabled and when i try and delete it says it is running.

I cannot get it to disable to remove. I have also rebooted the server but no joy.

Is there a way to remove this from a command terminal?

Thank you.

UCRM Invoice CSV Export

Hello, how can to add another column (items label) in the UCRM Invoice CSV Export, and the items be added in the same field (separated by a comma).
example
items Label: internet Basic 1 July 2019 – 31 July 2019, 1 Ago 2019 – 31 Ago 2019

Problems in QBO Plugin

No tax information is transferred from UCRM to QBO

• you must have organization setup for collecting taxes in QBO (does not deal with mutliple tax entities)
• will indicated taxed items and the total tax collected
  Payments are not tied to Invoices and show up in QBO as unapplied
• Need to handle payments made in advance of invoice generation
  Invoices and Payments can be assigned to the wrong client
  Should have quantity on invoice line item
  Need creation date and due date on Invoices
  Need paid date on payments
  Need to dump the chart accounts so user can set the correct income account number
• Intuit says they don't number the accounts, HA! This change will dump the chart of accounts the first time tokens are obtained. Account numbers change each time you use the QBO option purgecompany

Mikrotik Queue Sync is not working on version 1.0.4

Suspensión not working on UNMS 1.0.4

it was working very very fine in the previous version, and now is not working anymore

Error in Mikrotik Queue Sync Plugin

Notice: Undefined variable: ucrmFormatedList in /data/ucrm/data/plugins/mkt-queue-sync/classes/Synchronizer.php on line 220

Fatal error: Uncaught TypeError: Return value of MikrotikQueueSync\Synchronizer::formatUcrmListIpAddress() must be of the type array, null returned in /data/ucrm/data/plugins/mkt-queue-sync/classes/Synchronizer.php:220 Stack trace: #0 /data/ucrm/data/plugins/mkt-queue-sync/classes/Synchronizer.php(179): MikrotikQueueSync\Synchronizer->formatUcrmListIpAddress(Array) #1 /data/ucrm/data/plugins/mkt-queue-sync/classes/Synchronizer.php(130): MikrotikQueueSync\Synchronizer->getUcrmServiceList(Array) #2 /data/ucrm/data/plugins/mkt-queue-sync/public.php(49): MikrotikQueueSync\Synchronizer->sync() #3 /data/ucrm/data/plugins/mkt-queue-sync/public.php(51): {closure}() #4 /usr/src/ucrm/web/_plugins/mkt-queue-sync/public.php(3): require_once('/data/ucrm/data...') #5 {main} thrown in /data/ucrm/data/plugins/mkt-queue-sync/classes/Synchronizer.php on line 220

error when syncing

Passed array has no key for 'Value' when contructing an ReferenceType
Not sure what this means but I can't get invoices to sync

support list input types

It would be valuable if list input types are supported as some configurations requires list of items to be set.

Mikrotik Queue Sync plugin - configure multiple routers

Hi,

We have various Mikrotik routers which their queues need to be in sync with ucrm. As far as I can see with this plugin, currently this is not possible, only one router is supported.

Is there any plans to support multiple routers with this plugin ?

Suspension Plugin and Queues Plugin dont work

in the past the plugin was working fine but now the plugin is not working anymore

INCOMPATIBLE

En la sección de plugins de UNMS, aparece en Rojo "Incompatible"

mkt-queue-sync fails to initiate session

Before I submit this I should disclose I am not a PHP dev(Python and packets all day long though!). After installing mkt-queue-sync plugin, enabling and and both setting to sync every 30 and running manually, it does nothing. The plugin gives no status. I ran tcpdump from the server and the only packets going to the mikrotik are ICMP, which are successful. Here is capture without icmp.

ubuntu@ip-10-38-0-11:~$ sudo tcpdump host 10.0.0.2 and not icmp
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode
listening on eth0, link-type EN10MB (Ethernet), capture size 262144 bytes
^C
0 packets captured
0 packets received by filter
0 packets dropped by kernel
ubuntu@ip-10-38-0-11:~$

Not sure how to debug this to give better info, but happy to if given suggestions on how to. Are these plugins still being developed/supported in any way? If not, please let me know, and I will come up with a better solution. Thanks.

Plugins running on UCRM with self-signed certificate

Currently, Plugins which are using UCRM's API don't work when self-signed SSL certificated is deployed in your UCRM.

Solution could be:

• Add a new plugin option "validate UCRM's SSL certificate" (boolean: true/false)
• When Plugins connects to UCRM, this option will be used. When "false", SSL certificate will not be validated, and the plugin will work (it will be enabled to retrive/modify UCRM's data via API)

Quickbooks plugin import breaks with invoice present

In UNMS if I convert a lead to a customer, create an invoice and take payment for their service on the same day. The QB plugin will always fail with [error] Client with Display name containing: UCRMID-99 is not found.

This does not happen if I convert them to a customer and do not collect payment or invoice on the same day.

It may be that the plugin needs to try import all customers before attempting invoice and payment imports.

Suspension Plugin

It work correctly, but, i have 3 Mikrotiks in my network, how to setup the router ip?

UCRM Plugin Error

Hello,

Can someone tell me what this error message is telling me?

I install the plugin and followed the instructions to link my Quickbooks Online to CRM. After I execute the service, this is what I get...

Thanks for the help!

————————

[2020-05-07 1:09:01.569351] [info] CLI process started
[2020-05-07 1:09:02.266308] [notice] Authorization URL: https://appcenter.intuit.com/connect/oauth2?client_id=ABZZ8geHf4oZrDnWqv2xiud9jd2VvwvFuotQK1VeNctfnuRmRw&scope=com.intuit.quickbooks.accounting&redirect_uri=https%3A%2F%2Fshurenet.unmsapp.com%2Fcrm%2F_plugins%2Fquickbooks-online%2Fpublic.php&response_type=code&state=c27f337fd3c2166d79ba19fa
[2020-05-07 1:09:02.322019] [info] CLI process ended
[2020-05-07 1:11:01.608812] [error] Codes are not received. Configure this public URL as Redirect URI in QuickBook App and confirm connection in Authorization URL displayed in this log. https://appcenter.intuit.com/connect/oauth2?client_id=ABZZ8geHf4oZrDnWqv2xiud9jd2VvwvFuotQK1VeNctfnuRmRw&scope=com.intuit.quickbooks.accounting&redirect_uri=https%3A%2F%2Fshurenet.unmsapp.com%2Fcrm%2F_plugins%2Fquickbooks-online%2Fpublic.php&response_type=code&state=c27f337fd3c2166d79ba19fa

plugin not working when using unms custom port

Can't figure out why I'm getting connection refused on the public url when using a custom port on the crm/nms. Works just fine when using standard ports, but is not viable for me.

Any fix?

UNMS 1.1.6 clean install

ERROR Backup Dropbox (UCMR 1.3.1)

Uploaded file "unms-backup-20201204-1328_f130e825-044e-4d01-8d9f-26b36c0cb9be.unms". (2020-12-04T18:45:05-04:00)
ERROR: (2020-12-04T18:45:05-04:00)
Finished backup synchronization. (2020-12-04T18:45:05-04:00)

There is no such file:
{"level":30,"msg":"crond: USER root pid 65544 cmd crm-cron-enabled && /usr/src/ucrm/scripts/backup_control.sh","name":"unknown","hostname":"unknown","
pid":0,"v":0,"tag":"ucrm","time":"2020-12-04T00:00:00+00:00"}

QuickBooks plugin services link issues with invoices

Hey guys,

When the plugin syncs to qb, it syncs invoice line items as new products instead of a linked service product.

Anyway to fix this?

Thanks

No conecta a router via api

Buen día, espero puedan ayudar. Tengo este problema cuando inicio el servicio manualmente, aparece esto en mi mikrotik. Gracias. UCRM esta con ip 192.168.0.100 y Mikrotik en 192.168.0.81

new API docs

someone can help me implement this api to replace the twilio code. I have no idea about programming, but I can start with something.

api doc
https://developer.hablame.co/

Issue with User and Password on routeros-packet-manager

There is an error in the manifest.json on the following keys:

AdminUser
AdminPass

It should be pmAdminUser and pmAdminPass or the plugin will never validate with the correct user and password

Quickbooks plugin does not send the state to qbo

The plugin sends the city and zip codes, but does not send the state. Since the state is a code rather than the state in the client json response I suppose there needs to be a lookup table somewhere. The change to add the state logically would go in Facade after lines 155 and 161.