Description
Cette API donne un accès en lecture seule aux données Fuga.
Ces endpoints nécessitent généralement un traitement considérable. Des limitations de fréquence et d'horaire peuvent donc s'appliquer. Le cas échéant, elles sont communiquées dans la réponse d'une requête qui a échoué.
Nous mettons également à disposition une interface de base pour tester/utiliser cette API : Basic GUI.
Pour les utilisateurs connectés, des diagrammes ER sont également disponibles.
Prix
SuperFugaReporting fait partie de l'abonnement Concerto. Sans abonnement Concerto, le coût de SuperFugaReporting seul est de 2,6 EUR par compte vétérinaire.
Endpoints
Authentification
Authentification est fait par Basic Authentication : le nom d'utilisateur et le mot de passe nécessaires sont fournis par Sonetas sur demande, après validation par un responsable du client.
Requêtes
Informations indépendantes du cabinet
https://reporting.sonetas.eu/fuga/rest/super/reporting
GET practices
RETOURNE
http status 200 ok, avec un tableau json des practiceIds auxquels cet utilisateur a accès.
ou un autre http status en cas d'erreur
Informations spécifiques au cabinet
https://reporting.sonetas.eu/fuga/rest/super/reporting/{practiceId}
GET info
RETOURNE
http status 200 ok, avec un json contenant quelques informations sur le cabinet
ou un autre http status en cas d'erreur
Rapports
https://reporting.sonetas.eu/fuga/rest/super/reporting/{practiceId}
où {practiceId} est le cabinet interrogé.
Tous les rapports peuvent être demandés au format xml ou json. Le tableau ci-dessous donne un aperçu des rapports disponibles et de leurs paramètres (de filtre). Les paramètres marqués (M) sont obligatoires. Les dates sont encodées au format yyyyMMdd.
| Type de rapport | Description | Paramètres |
| Comptabilité | ||
| TClientWithInvoiceCreditNoteList | Liste des clients ayant reçu une facture ou une note de crédit pendant la période donnée | startDate (M), endDate (M) |
| TInvoiceList | Toutes les factures dont la date de référence (date de facture ou date de création) se situe dans la période demandée, avec le statut de paiement correct (payée ou non). | startDate (M), endDate (M), referenceDate(TFugaCreationDate/ TFinAccountDate(default)), paymentStatus (null/TPaid/ TNotPaid) |
| TInvoiceLineList | Liste des lignes de facture. Chaque ligne contient une colonne 'TArticleId' qui correspond au 'TIdWithOffset' dans les rapports TProducts/TActs/TProtocols. | startDate (M), endDate (M), referenceDate(TFugaCreationDate/ TFinAccountDate(default)) |
| TWithoutInvoiceList | Tous les reçus dont la date de référence (date du reçu ou date de création) se situe dans la période demandée. | startDate (M), endDate (M), referenceDate(TFugaCreationDate/ TFinAccountDate(default)), paymentStatus (null/TPaid/ TNotPaid) |
| TWithoutInvoiceLineList | Liste des lignes de reçu (règlement/note sans facture). La colonne 'TArticleId' correspond au 'TIdWithOffset' dans les rapports TProducts/TActs/TProtocols. | startDate (M), endDate (M), referenceDate(TFugaCreationDate/ TFinAccountDate(default)) |
| TCreditNoteList | Toutes les notes de crédit dont la date de référence (date de la note de crédit, date de dernière modification ou date de création) se situe dans la période demandée. | startDate (M), endDate (M), referenceDate(TFugaLastModifiedDate/TFugaCreationDate/ TCreditNoteDate(default)) |
| TCreditNoteLineList | Tous les détails des notes de crédit dont la date de référence (date de la note de crédit, date de dernière modification ou date de création) se situe dans la période demandée. | startDate (M), endDate (M), referenceDate(TFugaLastModifiedDate/TFugaCreationDate/ TCreditNoteDate(default)) |
| TInvoiceCreditNoteList | Liste des factures et notes de crédit pendant une période donnée | startDate (M), endDate (M) |
| TPaymentList | Liste des paiements pendant une période donnée, avec un mode de paiement donné | startDate (M), endDate (M), referenceDate(TFugaLastModifiedDate/TFugaCreationDate/ TPaymentDate(default)), paymentMethod (null/TCash/ TMoneyTransfer/….) |
| TOpenAccounts | Liste des comptes ouverts (contacts client facturables verrouillés pour lesquels aucune facture n'a encore été établie) | |
| TNotPaidFinAccounts | Liste de toutes les factures et de tous les reçus impayés | |
| TNotPaidFinReminders | Liste de tous les rappels de paiement impayés (frais de dossier) | |
| TVatClientList | Liste des clients assujettis à la TVA | startDate (M), endDate (M) |
| TIntraCommClientList | Liste des clients assujettis à la TVA intracommunautaire | startDate (M), endDate (M) |
| TLatePayers | Liste des clients ayant des factures non payées avant la date d'échéance | |
| Autres | ||
| TActiveClientList | Liste des clients ayant eu un contact client pendant la période donnée | startDate (M), endDate (M) |
| TNewClientList | Liste des clients ayant eu leur premier contact client pendant la période donnée | startDate (M), endDate (M) |
| TActivePersonList | Liste des personnes avec le statut 'actif' (nom, coordonnées et adresse) | partyType (TClient/TSupplier/TColleague/TFarrier/TLab/TInsurer/TPensionHolder) |
| TActiveAnimalList | Liste des animaux ayant eu un contact client pendant la période donnée | startDate (M), endDate (M) |
| TModifiedAnimalList | Liste des animaux modifiés pendant une période donnée | |
| TClientInteractionList | Liste des contacts client pendant la période donnée (sur base de la date du contact client) | startDate (M), endDate (M), referredToUsOnly (true/false, default=false) |
| TTreatmentReminderList | Liste des traitements prévus pendant la période donnée | startDate (M), endDate (M) |
| TProducts | Liste de tous les produits | depotNumber |
| TActs | Liste de tous les actes | |
| TProtocols | Liste de tous les protocoles | |
| TCurrentStockList | Stock actuel | |
| THistoricStockList | Stock historique | thresholdDate (M) |
| TIncomingRegisterList | Liste des livraisons de produits sur base de la date de livraison. Uniquement les entrées de stock normales | startDate (M), endDate (M) |
| TOutgoingRegisterList | Liste des produits sortants. Uniquement les sorties de stock normales | startDate (M), endDate (M) |
| TExecutedActs | Liste des actes exécutés | startDate (M), endDate (M) |
| TExecutedProtocols2 | Liste des protocoles exécutés | startDate (M), endDate (M) |
| TFinancialOverviewWork | Aperçu détaillé de tous les éléments facturés. La colonne 'TArticleId' correspond au 'TIdWithOffset' dans les rapports TProducts/TActs/TProtocols. | referenceDate (M:TBciDate/TCheckoutDate), startDate (M), endDate (M) |
| TCarePlanSubscriptions | Liste des abonnements aux plans de soins | currentOnly (true/false, default=true) |
| TAppointments | Liste des rendez-vous | startDate (M), endDate (M), bciType (null/TConsultationAtPractice/TOperation/THospitalization/ THomeVisit/TOperationOnSite/TSalesAtPractice/TSalesOnSite/ TExternal) |
| TCoworkers | Liste des collaborateurs |
GET report/{reportType}/?param1=value1¶m2=value2
avec :
- parami=valuei : les paramètres et valeurs propres au type de rapport
- le header Accept défini sur 'application/json', 'application/xml' ou 'text/plain' ('text/plain' renvoie les données au format csv)
RETOURNE
http status 200 ok, avec du xml ou du json
ou un autre http status en cas d'erreur