Press enter to see results or esc to cancel.

How to Integrate a 3rd Party Financial System with Clinicea

Introduction:

Sometimes when you come on board Clinicea, you may already be using a 3rd Party ERP for Inventory Management, or for Financial Accounting. While it is ideal to use 1 single system, but in practicality you may need to continue using multiple systems to ensure existing workflows and personnel are not impacted by changes in your technology setup. To achieve this, all such disparate systems need to to be in sync i.e. integration between them is required, so that data flows in and out seamlessly. In this guide we will review how to achieve this integration

So for the purpose of dealing with the above requirement, there will be 3 API calls you need to plugin in to. The 3 API calls required are as follows.

  1. getBills
  2. getDeletedBills
  3. getPayments

Let’s get down to the details of both this API calls one by one.

 

1. getBills

This API method is accessible through Bill Controller. This a GET method. The method will return the bill/invoice details as well as the bill item details for the Patients from a particular date. This will include the data from the new bills as well updated bills for every status including paid bills, due bills, exchanged bills, and cancelled bills except deleted bills. The data will return the first 100 rows for from that sync date.

Authorization: The API role must have the necessary financial permissions enabled in the Clinicea Application.

Details:

Parameter Description Type
lastSyncDate Last Sync date after which you want to retrieve New or Updated bills .This is the date from which you want the data to be retrieved from the database and synced with your software. So, for example if you pass the last sync date as 2018-01-01, it retrieve all those data from the 1st of Jan, 2018 till today‚Äôs date. Format should be an ISO 8601 notation in UTC ex: “2015-03-21T14:30:10”. This a STRING value.

 

intPageNo By default it is 1. #100 rows are returned per page. You need to iterate by calling this method again with increasing page numbers ex: 1, 2, 3 This is an Integer value

 

Possible Responses:

Status Response HTTP Code
Bill data is found for the request A JSON object which will return the bill details for date range ¬

200

Bill data is not found for the request No content 204

¬

 

2. getDeletedBills

This API method is accessible through Bill Controller. This a GET method. The method will return the bill/invoice details as well as the bill item details for the Patients from a particular date. This will include the data from the new bills as well updated bills for only deleted bills. The data will return the first 100 rows for from that sync date.

Authorization: The API role must have the necessary financial permissions enabled in the Clinicea Application.

Details:

Parameter Description Type
lastSyncDate Last Sync date after which you want to retrieve Deleted bills .This is the date from which you want the data to be retrieved from the database and synced with your software. So, for example if you pass the last sync date as 2018-01-01, it retrieve all those data from the 1st of Jan, 2018 till today‚Äôs date. Format should be an ISO 8601 notation in UTC ex: “2015-03-21T14:30:10”. This a STRING value.

 

intPageNo By default it is 1. #100 rows are returned per page. You need to iterate by calling this method again with increasing page numbers ex: 1, 2, 3 This is an Integer value

 

Possible Responses:

Status Response HTTP Code
Bill data is found for the request A JSON object which will return the bill details for date range ¬

200

Bill data is not found for the request No content 204

¬

 

3.¬ getPayments

This API method is accessible through Payment Controller. This a GET method. The method will return the Payment details for the Patients from a particular date. This will include the data related to the Payments. For the sake of simplicity, we have included the payment details for all status in this single method. So, you will be able to get new payments, cancelled payments as well as deleted payments data. So, this

The data will return the first 100 rows for from that sync date.

Authorization: The API role must have the necessary financial permissions enabled in the Clinicea Application.

Details:

Parameter Description Type
lastSyncDate Last Sync date after which you want to retrieve New or Updated, or Deleted payments .This is the date from which you want the data to be retrieved from the database and synced with your software. So, for example if you pass the last sync date as 2018-01-01, it retrieve all those data from the 1st of Jan, 2018 till today‚Äôs date. Format should be an ISO 8601 notation in UTC ex: “2015-03-21T14:30:10”. This a STRING value.

 

intPageNo By default it is 1. #100 rows are returned per page. You need to iterate by calling this method again with increasing page numbers ex: 1, 2, 3 This is an Integer value

¬

Possible Responses:

Status Response HTTP Code
Payment data is found for the request A JSON object which will return the Payment details for date range ¬

200

Payment data is not found for the request No content 204

¬

¬