L'outil sofi-bill-to-primmo est un script installé sur le même serveur que le logiciel Primmo et permet d'automatiser le transfert des services à la carte (SAC) facturables acceptés dans SOFI vers le logiciel Primmo. Ceci évite d'avoir à générer le fichier de transfert (format MDG) manuellement dans la tuile “Facturation des services” pour chaque résidence, éliminant ainsi la perte de temps et le risque d'erreur humaine.

Ce script exécute les opérations suivantes:

• Pour chacune des résidences configurées dans le fichier de configuration
  • Obtenir par l'API de SOFI la liste des SAC ayant le statut “Accepté” (en référence à la tuile “Facturation des services”) dans la plage de date configurée dans le fichier de config sofi-bill-to-primmo (s'il n'y a pas de dates précisées, alors sofi-bill-to-primmo prends tous les services avec le statut “Accepté” sans égards aux dates.)
  • Inscrire dans un fichier compatible à l'importation dans Primmo (format MDG) tous les SAC acceptés retrouvés à l'étape précédente afin de les facturer dans Primmo. Notez que tant que la transaction n'est pas complétée pour la résidence, alors le fichier des résultats est marqué comme temporaire (.tmp).
  • Assigner par l'API de SOFI le statut “Archivé” à tous les SAC qui ont été extraits dans le fichier (seulement si sofi-bill-to-primmo n'est pas exécuté en mode DryRun).
  • Enlever le statut temporaire au fichier des résultats (csv).

L'installation de Node.js est requis pour le bon fonctionnement de l'outil.

Le fonctionnement de l'outil requiert un utilisateur avec les droits et la clé pour accéder aux données de SOFI.

Vous devez créer un employé bien identifié dans l'instance SOFI avec la clé API et le secret utilisé dans l'application ayant besoin d'un accès.

Télécharger la dernière version de l'outil. Suivez le lien: https://gitlab.telemedic.ca/client-tools/sofi-bill-to-primmo/-/releases

Extraire le contenu du fichier compressé dans un sous-répertoire à la racine du disque C: (ex: c:\telemedic\billtoprimmo)

Il faut avoir les informations ci-dessous pour compléter la configuration.

Les informations de l'instance SOFI qui permettront a sofi-bill-to-primmo d'accéder aux données et les informations venant de Primmo qui identifient l'établissement qui doit être synchronisé.

Toutes ces valeurs sont optionnelles

{
	"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"
	}
}

Exécuter «run.cmd»

Le groupe d'accès utilisé doit disposer des autorisations nécessaires pour effectuer des archivages dans sa liste de droits.

 {
   "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.