Description


This API gives read-only access to Fuga data.


These endpoints typically require a considerable amount of processing, so rate and time-of-day limitations might apply. If so, these are communicated in the response of an unsuccessful request.


We also provide a basic gui to test/use this API: Basic GUI.


Endpoints


Query


Practice independent info


https://reporting.sonetas.eu/fuga/rest/super/reporting


GET practices


RETURNS

http status 200 ok, returning a json array of practiceIds to which this user has access.


or other http status on error


Practice specific info


https://reporting.sonetas.eu/fuga/rest/super/reporting/{practiceId}


GET info


RETURNS

http status 200 ok, returning json with some info about the practice


or other http status on error


Reports


https://reporting.sonetas.eu/fuga/rest/super/reporting/{practiceId}


with {practiceId} the queried practice.


All reports can be requested in xml or json format. Below table gives an overview of the available reports and their (filter) parameters. Parameters with an (M) are mandatory. Dates are encoded as yyyyMMdd.


Report type
Description
Parameters
Accounting


TClientWithInvoiceCreditNoteList
List of clients that received an invoice or creditNote in given period

startDate (M), endDate (M)

TInvoiceList
List of invoices

startDate (M), endDate (M), referenceDate(TFugaCreationDate/

TFinAccountDate(default)), paymentStatus (null/TPaid/

TNotPaid)

TInvoiceLineList
List of invoice lines. Each line contains a 'TArticleId' column which corresponds with the 'TIdWithOffset' in the TProducts/TActs/TProtocols reports.

startDate (M), endDate (M), referenceDate(TFugaCreationDate/

TFinAccountDate(default))

TWithoutInvoiceList
List of receipts (settlement/bill without invoice)

startDate (M), endDate (M), referenceDate(TFugaCreationDate/

TFinAccountDate(default)), paymentStatus (null/TPaid/

TNotPaid)

TWithoutInvoiceLineList
List of receipt lines (settlement/bill without invoice). The 'TArticleId' column corresponds with the 'TIdWithOffset' in the TProducts/TActs/TProtocols reports.

startDate (M), endDate (M), referenceDate(TFugaCreationDate/

TFinAccountDate(default))

TCreditNoteList
List of creditnotes

startDate (M), endDate (M), 

referenceDate(TFugaLastModifiedDate/TFugaCreationDate/

TCreditNoteDate(default))

TCreditNoteLineList
List of creditnote lines

startDate (M), endDate (M), 

referenceDate(TFugaLastModifiedDate/TFugaCreationDate/

TCreditNoteDate(default))

TPaymentList
List of payments

startDate (M), endDate (M), 

referenceDate(TFugaLastModifiedDate/TFugaCreationDate/

TPaymentDate(default)), paymentMethod (null/TCash/

TMoneyTransfer/….)

TOpenAccounts
List of open accounts (locked billable clientInteractions for which no invoice is made yet)

TNotPaidFinAccounts
List of all unpaid invoices and receipts

TNotPaidFinReminders    
List of all unpaid finReminders (dossier costs)

TVatClientList
List of VAT clients

startDate (M), endDate (M)

TIntraCommClientList
List of IC VAT clients

startDate (M), endDate (M)

Other


TActiveClientList
List of clients that had a clientInteraction in given period

startDate (M), endDate (M)


TActivePersonList
List of persons with status 'active' (name, contact info and address)

TActiveAnimalList
List of animals that had a clientInteraction in given period

startDate (M), endDate (M)


TClientInteractionList
List of clientInteractions in given period (based on date of the clientInteraction)

startDate (M), endDate (M)

TTreatmentReminderList
List of expected treatments in given period

startDate (M), endDate (M)


TProducts
List of all products
depotNumber
TActs
List of all acts

TProtocols
List of all protocols

TCurrentStockList
Current stock

THistoricStockList
Historic stock

thresholdDate (M)

TIncomingRegisterList
List of product deliveries based on delivery date

startDate (M), endDate (M)

TOutgoingRegisterList
List of outgoing products

startDate (M), endDate (M)

TExecutedActs
List of executed acts

startDate (M), endDate (M)

TExecutedProtocols2
List of executed protocols

startDate (M), endDate (M)

TFinancialOverviewWork
Detailed overview of all billed items. The 'TArticleId' column corresponds with the 'TIdWithOffset' in the TProducts/TActs/TProtocols reports.

referenceDate (M:TBciDate/TCheckoutDate), startDate (M), 

endDate (M)

TCarePlanSubscriptions
List of care plan subscriptions
currentOnly (true/false, default=true)
TAppointments
List of appointments

startDate (M), endDate (M), bciType (null/TConsultationAtPractice/TOperation/THospitalization/

THomeVisit/TOperationOnSite/TSalesAtPractice/TSalesOnSite/

TExternal)

TCoworkers
List of coworkers


GET report/{reportType}/?param1=value1&param2=value2


with:

- parami=valuei: the parameters and values for the specific report type

- Accept header set to 'application/json', 'application/xml' or 'text/plain' ('text/plain' will return data in csv format)


RETURNS

http status 200 ok, returning xml or json


or other http status on error


Database backup (TODO)


This call is redirected to a backup server that contains historic backups. The nightly backup is created at 2am and is available for retrieval at 4am.


GET dbBackup


RETURNS

http status 200 ok, returning a zipped sql.


or other http status on error