Beschrijving
Deze API geeft alleen-lezen toegang tot Fuga-gegevens.
Deze endpoints vragen doorgaans heel wat verwerking. Daarom kunnen er beperkingen gelden op frequentie en tijdstip. Indien van toepassing worden die meegedeeld in het antwoord op een mislukte aanvraag.
We stellen ook een eenvoudige interface ter beschikking om deze API te testen/gebruiken: Basic GUI.
Voor ingelogde gebruikers zijn er ook ER-diagrammen beschikbaar.
Prijs
SuperFugaReporting maakt deel uit van het Concerto-abonnement. Zonder Concerto-abonnement kost SuperFugaReporting apart 2,6 EUR per dierenartsaccount.
Endpoints
Authenticatie
Authenticatie gebeurt via Basic Authentication: de nodige gebruikersnaam en het wachtwoord worden op aanvraag door Sonetas bezorgd, na goedkeuring door een verantwoordelijke van de klant.
Aanvragen
Praktijkonafhankelijke informatie
https://reporting.sonetas.eu/fuga/rest/super/reporting
GET practices
RESULTAAT
http status 200 ok, met een json-array van de practiceIds waartoe deze gebruiker toegang heeft.
of een andere http status bij een fout
Praktijkspecifieke informatie
https://reporting.sonetas.eu/fuga/rest/super/reporting/{practiceId}
GET info
RESULTAAT
http status 200 ok, met een json met enkele gegevens over de praktijk
of een andere http status bij een fout
Rapporten
https://reporting.sonetas.eu/fuga/rest/super/reporting/{practiceId}
waarbij {practiceId} de opgevraagde praktijk is.
Alle rapporten kunnen in xml- of json-formaat opgevraagd worden. De tabel hieronder geeft een overzicht van de beschikbare rapporten en hun (filter)parameters. Parameters gemarkeerd met (M) zijn verplicht. Datums worden gecodeerd in het formaat yyyyMMdd.
| Rapporttype | Beschrijving | Parameters |
| Boekhouding | ||
| TClientWithInvoiceCreditNoteList | Lijst van klanten die in de opgegeven periode een factuur of kredietnota ontvingen | startDate (M), endDate (M) |
| TInvoiceList | Alle facturen waarvan de referentiedatum (factuurdatum of aanmaakdatum) binnen de gevraagde periode valt, met de correcte betaalstatus (betaald of niet). | startDate (M), endDate (M), referenceDate(TFugaCreationDate/ TFinAccountDate(default)), paymentStatus (null/TPaid/ TNotPaid) |
| TInvoiceLineList | Lijst van factuurlijnen. Elke lijn bevat een kolom 'TArticleId' die overeenkomt met de 'TIdWithOffset' in de rapporten TProducts/TActs/TProtocols. | startDate (M), endDate (M), referenceDate(TFugaCreationDate/ TFinAccountDate(default)) |
| TWithoutInvoiceList | Alle ontvangstbewijzen waarvan de referentiedatum (datum van het ontvangstbewijs of aanmaakdatum) binnen de gevraagde periode valt. | startDate (M), endDate (M), referenceDate(TFugaCreationDate/ TFinAccountDate(default)), paymentStatus (null/TPaid/ TNotPaid) |
| TWithoutInvoiceLineList | Lijst van lijnen van ontvangstbewijzen (afrekening/nota zonder factuur). De kolom 'TArticleId' komt overeen met de 'TIdWithOffset' in de rapporten TProducts/TActs/TProtocols. | startDate (M), endDate (M), referenceDate(TFugaCreationDate/ TFinAccountDate(default)) |
| TCreditNoteList | Alle kredietnota's waarvan de referentiedatum (datum van de kredietnota, datum van laatste wijziging of aanmaakdatum) binnen de gevraagde periode valt. | startDate (M), endDate (M), referenceDate(TFugaLastModifiedDate/TFugaCreationDate/ TCreditNoteDate(default)) |
| TCreditNoteLineList | Alle details van kredietnota's waarvan de referentiedatum (datum van de kredietnota, datum van laatste wijziging of aanmaakdatum) binnen de gevraagde periode valt. | startDate (M), endDate (M), referenceDate(TFugaLastModifiedDate/TFugaCreationDate/ TCreditNoteDate(default)) |
| TInvoiceCreditNoteList | Lijst van facturen en kredietnota's in een opgegeven periode | startDate (M), endDate (M) |
| TPaymentList | Lijst van betalingen in een opgegeven periode, met een opgegeven betaalmethode | startDate (M), endDate (M), referenceDate(TFugaLastModifiedDate/TFugaCreationDate/ TPaymentDate(default)), paymentMethod (null/TCash/ TMoneyTransfer/….) |
| TOpenAccounts | Lijst van openstaande lopende rekeningen (vergrendelde factureerbare klanteninteracties waarvoor nog geen factuur werd opgemaakt) | |
| TNotPaidFinAccounts | Lijst van alle onbetaalde facturen en ontvangstbewijzen | |
| TNotPaidFinReminders | Lijst van alle onbetaalde betalingsherinneringen (dossierkosten) | |
| TVatClientList | Lijst van btw-plichtige klanten | startDate (M), endDate (M) |
| TIntraCommClientList | Lijst van klanten onderworpen aan intracommunautaire btw | startDate (M), endDate (M) |
| TLatePayers | Lijst van klanten met facturen die niet vóór de vervaldatum betaald werden | |
| Andere | ||
| TActiveClientList | Lijst van klanten die in de opgegeven periode een klanteninteractie hadden | startDate (M), endDate (M) |
| TNewClientList | Lijst van klanten die in de opgegeven periode hun eerste klanteninteractie hadden | startDate (M), endDate (M) |
| TActivePersonList | Lijst van personen met de status 'actief' (naam, contactgegevens en adres) | partyType (TClient/TSupplier/TColleague/TFarrier/TLab/TInsurer/TPensionHolder) |
| TActiveAnimalList | Lijst van dieren die in de opgegeven periode een klanteninteractie hadden | startDate (M), endDate (M) |
| TModifiedAnimalList | Lijst van dieren die in een opgegeven periode gewijzigd werden | |
| TClientInteractionList | Lijst van klanteninteracties in de opgegeven periode (op basis van de datum van de klanteninteractie) | startDate (M), endDate (M), referredToUsOnly (true/false, default=false) |
| TTreatmentReminderList | Lijst van geplande behandelingen in de opgegeven periode | startDate (M), endDate (M) |
| TProducts | Lijst van alle producten | depotNumber |
| TActs | Lijst van alle handelingen | |
| TProtocols | Lijst van alle protocols | |
| TCurrentStockList | Huidige stock | |
| THistoricStockList | Historische stock | thresholdDate (M) |
| TIncomingRegisterList | Lijst van productleveringen op basis van de leveringsdatum. Enkel normale stockinkomsten | startDate (M), endDate (M) |
| TOutgoingRegisterList | Lijst van uitgaande producten. Enkel normale stockuitgangen | startDate (M), endDate (M) |
| TExecutedActs | Lijst van uitgevoerde handelingen | startDate (M), endDate (M) |
| TExecutedProtocols2 | Lijst van uitgevoerde protocols | startDate (M), endDate (M) |
| TFinancialOverviewWork | Gedetailleerd overzicht van alle gefactureerde elementen. De kolom 'TArticleId' komt overeen met de 'TIdWithOffset' in de rapporten TProducts/TActs/TProtocols. | referenceDate (M:TBciDate/TCheckoutDate), startDate (M), endDate (M) |
| TCarePlanSubscriptions | Lijst van abonnementen op zorgplannen | currentOnly (true/false, default=true) |
| TAppointments | Lijst van afspraken | startDate (M), endDate (M), bciType (null/TConsultationAtPractice/TOperation/THospitalization/ THomeVisit/TOperationOnSite/TSalesAtPractice/TSalesOnSite/ TExternal) |
| TCoworkers | Lijst van medewerkers |
GET report/{reportType}/?param1=value1¶m2=value2
met:
- parami=valuei: de parameters en waarden eigen aan het rapporttype
- de Accept-header ingesteld op 'application/json', 'application/xml' of 'text/plain' ('text/plain' geeft de gegevens terug in csv-formaat)
RESULTAAT
http status 200 ok, met xml of json
of een andere http status bij een fout