The sofi-bill-to-primmo tool is a script installed on the same server as the Primmo software and allows you to automate the transfer of billable A la carte services accepted in SOFI to the Primmo software. This avoids having to generate the transfer file (MDG format) manually in the “Billing Services” tile for each residence, thus eliminating the loss of time and the risk of human error.

This script performs the following operations:

• For each of the residences configured in the configuration file.
• Obtain through the SOFI API the list of VS with the status “Accepted” (in reference to the “Billing Services” tile) in the date range configured in the sofi-bill-to-primmo config file (if there are no dates specified, then sofi-bill-to-primmo takes all the services with the status “Accepted” regardless of the dates)
• Enter in a file compatible with Primmo import (MDG format) all accepted VS found in the previous step in order to bill them in Primmo. Note that as long as the transaction is not completed for the residence, then the results file is marked as temporary (.tmp).
• Assign by the SOFI API the status “Archived” to all VS that have been extracted in the file (only if sofi-bill-to-primmo is not run in DryRun mode).
• Remove the temporary status from the results file (csv).

Installation of Node.js is required for the tool to work properly.

The operation of the tool requires a user with the rights and key to access the SOFI data.

You must create an employee properly identified in the SOFI instance with the API key and the secret used in the application that needs access.

Download the latest version of the tool. Follow the link: https://gitlab.telemedic.ca/client-tools/sofi-bill-to-primmo/-/releases

Extract the content of the compressed file into a subdirectory at the root of the C: drive (e.g. c:\telemedic\billtoprimo)

To configure sofi-bill-to-primmo, you need to have the following information.

The information from the SOFI instance that will allow sofi-bill-to-primmo to access the data and the information from Primmo that identifies the institution that needs to be synchronized.

All these values are optional

{
	"Companies": [
		{
			"url": "https://siteduclient1.telemedic.ca",
			"apiaccesskey": "COMPANY1_API_ACCESS_KEY",
			"apisecret": "API_SECRET",
			"PrimmoBilling": {
				"VendorId": null, 
				"MdgFormatCol09": null, 
				"MdgFormatCol11": null, 
				"MdgFormatCol14": null, 
				"MdgFormatCol15V": null, 
				"MdgFormatCol15P": null
			}
		},
		{
			"url": "https://siteduclient2.telemedic.ca",
			"apiaccesskey": "COMPANY1_API_ACCESS_KEY",
			"apisecret": "API_SECRET",
			"PrimmoBilling": {
				"VendorId": null, 
				"MdgFormatCol09": null, 
				"MdgFormatCol11": null, 
				"MdgFormatCol14": null, 
				"MdgFormatCol15V": null, 
				"MdgFormatCol15P": null
			}
		}
	],
	"DryRun": true,
	"_comment": "StartDate 2023-01-01T00:00:00Z",
	"_comment": "EndDate 2023-08-16T23:59:59Z",
	"Language": "FR",
	"OutputDirectory": "output",
	"FileLogging": {
		"FilePath": "log"
	}
}

Execute «run.cmd»

The access group used must have the necessary authorisations to carry out archiving in its list of rights.

 {
   "Billing": {
        "CanArchive": true
    }
 }

[WARN] IMPORTANT! DryRun will create the files but will not set archived status for charges. : Indique que sofi-bill-to-primmo s’exécute en mode DryRun et donc ne fera pas l’archivage des SAC facturables.

[ERROR] Files found in the output directory, check logs and clean output directory before retrying : sofi-bill-to-primmo arrête son exécution puisqu’il y a déjà des fichiers de type .csv ou .tmp dans le répertoire de sortie.

[ERROR] Invalid client credentials for VendorId X : L’information de clé-secret fournie pour se connecter à l’API du vendor ID est erronée ou l’utilisateur n’a pas les droits d’accès sur l’API.

[ERROR] default - Invalid output directory 'XXXX' : Le répertoire de sortie pour les fichiers de facturation n’existe pas.

[INFO] default - Log directory 'XXXX' created : L’outil sofi-bill-to-primmo informe de la création du répertoire de journalisation XXXX.

[INFO] default - Output directory is set to 'output' : L’outil sofi-bill-to-primmo informe que le répertoire par défaut ‘output’ est utilisé pour la génération des fichiers de facturation.

[INFO] default - Company XXXX, VendorId: 901. 1 resident(s) not processed (missing ExternalId) : indique que sofi-bill-to-primmo a détecté un (des) résident(s) qui a(ont) des services facturables, mais qui n’ont pas d’ExternalID. Ces services ne seront pas traités par sofi-bill-to-primmo.