{"info":{"_postman_id":"0490415e-f59c-4557-99c2-ecbf686a6234","name":"Sikka APIs","description":"

Sikka Platform Cloud provides APIs so you can quickly build secure apps\nfor over 96 % of dental, veterinary, audiology and optometry industries.Use our API to gain access to all the opt - in HIPAA / HITECH compliant rich data that a healthcare practice generates.

\n
Join our Ecosystem and build your own Apps!The Sikka Ecosystem harnesses the power of over 36 unique apps\nfor you to gain full control of your practice,\nwhile viewing real - time industry metrics, securely - all at your fingertips!\nVisit : Sikka Marketplace
\n

Getting Started

Welcome to Sikka API. Here you will find the step-by-step guide that will help you build an application on the Sikka Platform and full listing of all the available APIs. As we add more APIs, they will automatically documented here and available to you as per your API plan. For more information about a particular endpoint, click on its name. You will be taken to the API’s documentation page, which includes what query parameters the API will accept, what the JSON or XML parameters will be in the response, and an example.

Follow Below Steps

Step 1 : Register an app with Sikka
Step 2 : Add clients to your app
Step 3 : Get an authorization
Step 4 : Install SPC (Sikka Platform Cloud)
Step 5 : Fetching and displaying data

\n
What developers need to do?
\n
$\"sikka$
\n

\n
What your clients need to do to display data?
\n
$\"developer$
\n

\n
Prerequisite
\n
To fetch the data you will need to add practice to your app. SPC (Sikka Platform Cloud) must be installed on practice to fetch the data.
\n

Step 1 : Register an app with Sikka

Please provide all necessary information about your App. It will help us to authorize your app.

After successful App registration you will get an application id and application key. Keep these keys safe as it will require to fetch the data from practice.

\n
Note : Do not disclose your keys.
\n

Step 2 : Add clients to your app

Contact sikka software API team for detail information.

Step 3 : Get an authorization

We do support oAuth 2.0

oAuth 2.0 is a protocol that lets your app access the practice details in a Sikka account without getting their password.

You'll need to register your app before getting started. A registered app is assigned a unique Application ID (Client ID) and Application Secret Key (Client Secret) which will be used in the OAuth flow. The Application ID and Application Secret Key should not be shared.

Sign in with Sikka ( You will find the url in API portal, under 'Application Details' as 'authorization link') is the best way to log individual user into your application.

The oAuth Flow

Step 1 - Authorization

Your web or mobile app should redirect users to the following URL:

https://api.sikkasoft.com/portal/authapp.aspx?response_type=code&client_id=APPLICATION_ID&redirect_uri=REDIRECT_URI&scope=*&state=123456

The following values should be passed as GET parameters:

client_id = Issued when you created your app (Application ID). (required)
response_type = code - Indicates that your server expects to receive an authorization code. (required)
redirect_uri = Indicates the URI to return the user to after authorization is complete. (optional)
scope = GLOBAL - It allows you to access client information based on your API licenses. (required)
state = A random string generated by your application, which you'll verify later. This parameter’s value should be an anti-forgery token to protect against cross-site request forgery (CSRF). (optional)

Step 2 - Allow Access

After successful login user sees the authorization prompt

$\"oauth$

If the user clicks \"Allow\", the service redirects the user back to redirect_uri site with an auth code. Sikka API server generate random AUTH_CODE.

https://redirect_uri?code=AUTH_CODE_HERE&state=123456

code = The server returns the authorization code in the query string.
state = The server returns the same state value that client passed.

What developer/ API user should do ?

Developer should first compare this state value to ensure it matches the one you started with. You can typically store the state value in a cookie or session, and compare it when the user comes back. This ensures your redirection endpoint isn't able to be tricked into attempting to exchange arbitrary authorization codes.

Storing tokens and credentials

Store your application's credentials and user tokens with care.

Redirect URIs

The redirect_uri parameter is optional. If left out, it will redirect users to the callback URL configured in your app's settings. If provided, the redirect URL's host and port must exactly match the callback URL. The redirect URL's path must reference a subdirectory of the callback URL.

CALLBACK: http://example.com/path

GOOD: https://example.com/path

GOOD: http://example.com/path/subdir/other

Step 3 - Token( request_key ) Issuing

If the user authorizes your app, Sikka will redirect back to your specified redirect_uri with a temporary code in a code GET parameter, as well as a state parameter if you provided one in the previous step. If the states don't match, the request may have been created by a third party and you should abort the process.

Your server exchanges the auth code for an access token:

Sample request :

POST https://api.sikkasoft.com/v2/token\nContent-Type : application/json\n{\n\"grant_type\":\"authorization_code\",\n\"code\":\"AUTH_CODE_HERE\",\n\"redirect_uri\":\"REDIRECT_URI\",\n\"client_id\":\"APPLICATION ID\",\n\"client_secret\":\"APPLICATION SECRET KEY\"\n}\n

grant_type = authorization_code - The grant type for this flow is authorization_code.
code = AUTH_CODE_HERE - This is the code you received in the query string.
redirect_uri = REDIRECT_URI - Must be identical to the redirect URI provided in the original link.
client_id = CLIENT_ID - The Application ID you received when you first created the application.
client_secret = Application secret key - Since this request is made from server-side code, the secret is included.\nThe server replies with an access token and expiration time [Please note here: 'access_token' and 'request_key' are same.]

Response :

{ \n\"scope\": \"https://api.sikkasoft.com/v2/\",\n\"access_token\": \"d25c47ca453a42bc9133d76b1719eb18\",\n\"request_key\": \"d25c47ca453a42bc9133d76b1719eb18\",\n\"token_type\": \"Bearer\",\n\"expires_in\": \"86400\"\n\"refresh_token\":\"01234567-89ab-cdef-0123-456789abcdef\"\n}\n

Token refresh

Access tokens/request_keys expire 24 hours after they are issued. The refresh token can be used to make a request for a new access token/request_key, similar to the initial access token exchange. Refresh tokens don’t expire until you delete refresh token.

Sample Request :

POST https://api.sikkasoft.com/v2/token\nContent-Type =Application/json\n{\n\"grant_type\":\"refresh_token\",\n\"refresh_token\":\"01234567-89ab-cdef-0123-456789abcdef\",\n\"client_id\":\"application id\",\n\"client_secret\":\"Application Secret Key\"\n}\n

Response :

{ \n\"scope\": \"https://api.sikkasoft.com/v2/\",\n\"access_token\": \"d25c47ca453a42bc9133d76b1719eb18\",\n\"request_key\": \"d25c47ca453a42bc9133d76b1719eb18\",\n\"token_type\": \"Bearer\",\n\"expires_in\": \"86400\"\n\"refresh_token\":\"01234567-89ab-cdef-0123-456789abcdef\"\n}\n

Revoking tokens

If you want to dispose of an oAuth token, use delete refresh_token.

By revoking the last token associated between your application and a user, your application will not be able to access practice data.

DELETE https://api.sikkasoft.com/v2/refresh_token/{refresh_token}?client_id={client_id}&client_secret={client_secret}

refresh_token = oAuth refresh_token you want to revoke. (required)
client_id = Application id - Issued when you created your app (Application ID). (required)
client_secret = Application secret key - Since this request is made from server-side code, the secret is included.

Step 4 : Install SPC

Download and Install SPC (Sikka Platform Cloud)

\n
Prerequisite
\n

\n
SPC should be install on practice management system server. In short SPC and practice management system should be on same machine\nSPC will require username and password for sikka account
\n

Step 5 : Fetching and displaying data

To fetch the data via Sikka API you will need request key. Sample API request to generate request key

Request

https://api.sikkasoft.com/v2/start?app_id={appid}&app_key={appkey}&office_id={officeid}&secret_key={secret_key}

Response

{\n\"scope\": \" https://api.sikkasoft.com/v2/ \"\n\"request_key\":\"xxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n\"token_type\":\"xxxxxx\",\n\"expires_in\":\"24 hours\"\n}\n

For more information about a particular endpoint, go to API v2.0 documentation. You will be taken to the API’s documentation page, which includes what query parameters the API will accept, what the JSON or XML parameters will be in the response, and an example.

Quickstart

In this guide we will walk you through all necessary steps to start accessing data from practice.

1.Authorized practices:

This API will give you the list of practices from which you can access data

https://api.sikkasoft.com/auth/v2/authorized_practices?app_id={your application id}&app_key={ your application key }\n

Returns 'office_id' and 'secret_key'

2.Start call to get Request Key for practices:

In response of ‘authorized_practices’ API you have ‘office_id’ and ‘secret_key’. Use it in ‘start’ API

https://api.sikkasoft.com/v2/start?app_id={your application id}&app_key={ your application key }&office_id={office_id}&secret_key={secret_key}\n

Returns Request Key: i.e '52457c9dhgfttfk88798793a4c7e4fa54902'

3.Patients API call:

API to get the list of patients

https://api.sikkasoft.com/v2/patients?request_key={request_key}\n

For veterinary hospitals use ‘veterinary_patients’ API to get the list of pets

https://api.sikkasoft.com/v2/patients/veterinary_patients?request_key={request_key}\n

After step 3

4.Pet Owners call:

API to get the list of pet owners

https://api.sikkasoft.com/v2/guarantors?request_key={request_key}&offset=0&limit=10\n

API Field Filtering

The default endpoints of the Sikka REST API are designed to be sensible defaults in terms of what data is returned.\nFields parameter provides a single way for modifying all responses for an object. For example, in patients API there are around 50 fields but your application needs only 5 of them, Fields parameter allows you to get only 5 fields.

Important Note about Field Filtering

The API exposes many fields on API responses, including things you might not need, or might not fit into how your application works. While it's tempting to modify or remove fields from responses, this will cause problems with API clients that expect standard responses. This includes things like mobile clients or third party tools.\nYou may only need a small amount of data, but it's important to keep in mind that the API is about exposing an interface to all clients, not just the feature you're working on.

What fields Parameter Does

In every Sikka API fields parameter allows to return only requested fields. Other fields will not be display in API response. Please note that there are certain fields which user can not remove from API response. Those are the mandatory fields. To get the whole list of mandatory fields please contact Sikka API team

How to Use Fields Parameter

Sikka API accepts fields as parameters:\nIn fields parameters users needs to specify which fields API should return in response.\nThis means that if you specify

https//api.sikkasoft.com/v2/patients?request_key={ }&fields= firstname,lastname, cell ```\nIt will return only first name , last name ,cell & mandatory fields only. It will skip / hide other fields.\n\nExamples\n```javascript\nURL : https://api.sikkasoft.com/v2/practices?request_key={valid request key}\n

Response :

{\n\"href\": \"https://api.sikkasoft.com/v2/practices/1\",\n\"practice_id\": \"1\",\n\"name\": \"Second Site Location\",\n\"address_line1\": \"12345 Any Street\",\n\"address_line2\": \"\",\n\"city\": \"Mt. Vernon\",\n\"state\": \"IL\",\n\"zipcode\": \"62864\",\n\"phone\": \"\",\n\"country\": \"\",\n\"email\": \"\",\n\"website\": \"\",\n\"providers\": {\"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/\"},\n\"patients\": {\"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/\"},\n\"guarantors\": {\"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/\"},\n\"appointments\": {\"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments/\"},\n\"transactions\": {\"href\": \"https://api.sikkasoft.com/v2/practices/1/transactions/\"}\n}\n

Now if user wants to see only “name” in response and skip other fields

URL : https://api.sikkasoft.com/v2/practices?request_key={valid request key}&fields=name\n

Response :

{\n\"href\": \"https://api.sikkasoft.com/v2/practices/1\",\n\"practice_id\": \"1\",\n\"name\": \"Second Site Location\",\n\"providers\": {\"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/\"},\n\"patients\": {\"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/\"},\n\"guarantors\": {\"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/\"},\n\"appointments\": {\"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments/\"},\n\"transactions\": {\"href\": \"https://api.sikkasoft.com/v2/practices/1/transactions/\"}\n}\n

Expanding Objects

Many objects contain the ID of a related object in their response properties. For example, a patient may have an associated practice id, guarantor id, provider d. Those objects can be expanded in line with the expand request parameter. Objects that can be expanded are noted in this documentation. This parameter is available on all API requests, and applies to the response of that request only.\nYou can nest expand requests with the expand parameter. For example, requesting \"expand=practice\" on a patient will expand the patient object with practice object. Response will be patient API response, including practice object.\nYou can expand multiple objects at once by identifying multiple items in the expand parameter, separated by comma (\",\").

Request :

URL : https://api.sikkasoft.com/v2/patients/76?request_key={valid request key}&expand=practice\n

Response :

\n{\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/76\",\n\"patient_id\": \"76\",\n\"guarantor_id\": \"76\",\n\"firstname\": \"Kvana\",\n\"middlename\": \"\",\n\"lastname\": \"Aws4\",\n.....\n\"practice_id\": \"1\",\n        \"practice\": {\n        \"href\": \"https://api.sikkasoft.com/v2/practices/1\",\n        \"practice_id\": \"1\",\n        \"name\": \"Test Dental\",\n        \"address_line1\": \"\",\n        \"address_line2\": \"\",\n        \"city\": \"San Jose\",\n        \"state\": \"CA\",\n        \"zipcode\": \"95110\",\n        \"phone\": \"xxx-xxx-xxxx\",\n        \"country\": \"\",\n        \"email\": \"\",\n        \"website\": \"\",\n        \"description\": \"\",\n        \"providers\": {\n        \"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/\"\n        },\n\"hygienist\": \"\"\n}\n\n

Pagination

Requests for collections can return between 0 and 4999 results, controlled using the limit and offset query parameters. All end points are limited to 500 results by default.

GET /v2/patients?request_key={request_key}&offset=0&limit=4999 Return rows from 0 to 4999

The offset should be the page offset (not the item offset). Also, limit will denote page size, along with limit of rows returned.

 offset = 0 and limit = 940 will return the 1st 940 rows\noffset = 1 and limit = 940 will return rows 941 to 1880\noffset = 1 and limit = 941 will return rows 942 to 1882 (Page offset = 1, page size = 941, limit rows = 941)\noffset = 2 and limit = 940 will return rows 1881 to 2820\n

Modified Records

How to get only modified records ?

There are two ways to get modified records

Use practice_events API. It will return data with specific records with flag ( added , deleted or updated)
\n
Pass loaded_startdate and loaded_enddate to API . It will return change logs of records with flag ( added/deleted) . see below example
\n

There are below parameters in Sikka API to get only modified records :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required
loaded_startdate	Start date for getting only changed record set. Date format : yyyy-mm-dd or yyyy-MM-ddTHH:mm:ss	No
loaded_enddate	End date for getting only changed record set. Date format : yyyy-mm-dd or yyyy-MM-ddTHH:mm:ss	No
flag	Flag for data changes (added, deleted)	No
interval	Value must be integer. 'interval' parameter allows user to fetch records , which has been changed in last minutes. This will be helpful when user does not know loaded_startdate/loaded_enddate and just want to fetch records which has been changed in last minutes (let say 5,10,15.. etc minutes). Maximun value for interval is 1440. You can fetch data which has been changed in last 24 hours (1440 minutes, interval=1440) without specifying loaded_startdate and loaded_enddate. Note : Make sure Sikka platform utility is up and running on client machine. To check when Sikka platform utility (SPU) has refreshed, call 'authorized_practices' and get 'data_insert_date'.	No

loaded_startdate & loaded_enddate will help you to fetch modified records between given date time range.\nflag indicates whether record has been deleted or added.

https://api.sikkasoft.com/v2/{api_name}?request_key={}&loaded_startdate={ }&loaded_enddate={ } \n

Response :

{\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments/3206e13d\",\n\"appointment_sr_no\": \"3206e13d\",\n\"patient_id\": \"1\",\n\"operatory\": \"\",\n\"date\": \"2015-11-02\",\n\"time\": \"08:40:00\",\n\"length\": \"60\",\n\"description\": \"testing1\",\n\"amount\": \"9999.0000\",\n\"status\": \"confirmed\",\n\"last_changed_date\": \"2015-12-21\",\n\"appointment_made_date\": \"2015-11-02\",\n\"provider_id\": \"LW\",\n\"flag\":\"Deleted/ Added\", [it will tell you record is deleted or added]\n\"patient_name\":\"Sat Yen\",\n\"guarantor_id\": \"1\",\n\"guarantor_name\": \"guarnator1\"\n} \n

Example :

1.Sikka API (like patients, appointments etc... ) always shows live data; extracted from PMS. Whenever you call Sikka API it is latest data.

How to check latest data activity & retrieve modified records :

1a. To check when Sikka has pulled data from PMS, you can use 'authorized_practices' API, instead keep calling Sikka APIs (patients, appointments, transactions etc... ).

'authorized_practices' API will give you the status of each practice with refresh date & when last time data inserted.

https://api.sikkasoft.com/auth/v2/authorized_practices?app_id={your application id }&app_key={your application key} \n

Response :

{\n\"office_id\": \"_D....\",\n\"domain\": \"Dental\",\n\"href\": \"https://api.sikkasoft.com/auth/v2/authorized_practices/D15\",\n\"secret_key\": \"_xxxx_.....\",\n\"practice_name\": \"\",\n\"address\": \"1650 B_f\",\n\"city\": \"Gettysburg\",\n\"state\": \"PA\",\n\"zip\": \"17325\",\n\"practice_management_system\": \"SoftDent\",\n\"financial_system\": \"\",\n\"practice_management_system_refresh_date\": \"2017-03-01 14:04:08\"\n\"data_synchronization_date\": \"2017-03-01 14:09:04\",\n\"data_insert_date\": \"2017-03-01 14:10:08\", [You need to check this time and it should be your trigger time to call APIs. If this time is greater than your last API call time then you can run APIs again to pull data.]\n\"practice_management_system_version\": \"V14.2\",\n\"practice_management_system_refresh_date_time_zone\": \"Eastern Standard Time\" [It shows above date time is in which time zone.]\n}\n

1b. For example :

Current time is 2017-03-01 11:52:00 & last data_insert_time at 2017-03-01 10:52:00. Now you want to get the list of how many appointments inserted and deleted from PMS.

https://api.sikkasoft.com/v2/appointments?request_key={}&loaded_startdate=2017-03-01T10:52:00&loaded_enddate=2017-03-01T11:52:00\n

Response :

{\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments/3206e13d\",\n\"appointment_sr_no\": \"3206e13d\",\n\"patient_id\": \"1\",\n\"patient\": {\n    \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/1\"\n    },\n\"operatory\": \"\",\n\"flag\":\"Deleted/ Added\", [it will tell you record is deleted or added],\n\"patient_name\":\"Sat Yen\",\n\"guarantor_id\": \"1\",\n\"guarantor_name\": \"guarnator1\"\n}\n

Output Formats

The Sikka API handles multiple output formats. Currently, the only supported formats are JSON and XML Output formats are selected with a specifier that is appended to the URL, like :

JSON response :

https://api.sikkasoft.com/v2/{api name}/json?request_key={ }\n

XML response :

https://api.sikkasoft.com/v2/{api name}/xml?request_key={ }\n

Default response :

https://api.sikkasoft.com/v2/{api name}?request_key={ }\n

JSON is the default, and will be used if nothing is specified.

HTTP Compression

Sikka API supports HTTP compression of response bodies using standards defined by the HTTP 1.1 specification. Enabling compression is recommended because it reduces bandwidth usage, and time spent retrieving data.

To enable compression, include the following HTTP header in the request:

GET        /patients         HTTP/1.1\nHost:     www.domain.com\nAccept-Encoding:     gzip,compress\n

The server understands the compression algorithms from Accept-Encoding and use algorithm to compress the representation before serving it. When successfully compressed, server lets know the client of encoding scheme by another HTTP header i.e. Content-Encoding

200 OK\nContent-Encoding:     gzip\n

Compression can save a lot of bandwidth, with very little cost in additional complexity. Also you may know that most web browsers automatically request compressed representations from website host servers – using above headers.

References:

https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3

Error Codes

Error Code	HTTP Code	HTTP Code Description	Short Message	Long Message	More Info
API0003	200	OK	OK	Request Session terminated successfully.
API0004	200	OK	Email/Text message sent successfully.
API0005	200	OK	Email/Text message not sent.
API0006	200	OK	Call details logged successfully.
API0008	200	OK	Appointment status not logged.
API1001	400	BadRequest	Missing Parameter	ApplicationID is missing.	Please provide the applicationid.
API1002	400	BadRequest	Missing Parameter	ApplicationKey is missing.	Please provide the applicationkey.
API1003	400	BadRequest	Missing Parameter	MID is missing.	Please provide the mid.
API1004	400	BadRequest	Missing Parameter	Requestkey is missing.	Please provide the requestkey.
API1005	400	BadRequest	Missing Parameter	SecretKey is missing.	Please provide the secretkey.
API1006	415	UnsupportedMediaType	Sikka API supports json/xml	Sikka API does not support response format.	Please request with json/xml.
API1007	200	OK	Appointment status logged successfully
API1020	400	BadRequest	Missing Parameter	One of the parameter is missing.	Please provide all the parameters in syntax of service.
API1025	400	BadRequest	Request key expired	Request key is not valid, it is expired.	Please generate new request key and make new request.
API1026	400	BadRequest	Missing/Invalid Parameter	One of the parameter is missing or invalid.
API1027	400	BadRequest
API2001	500	InternalServerError	Internal Error	Internal Error.	Please contact Sikka API Support.
API2002	503	ServiceUnavailable	Try again later.	The Sikka APIs are up, but overloaded with requests. Try again later.
API2003	401	Unauthorized	Authentication/Authorization Failed	ID or key is incorrect.	This error can be caused by an incorrect application id , application key. In case of provider_accounts & patient_accounts this error can be caused by incorrect username or password.
API2004	401	Unauthorized	Authentication/Authorization Failed	You are not authorized to use this API.	This error can be caused when you try to access API not accessible by you, if you want to use this API contact SIKKA API SUPPORT.
API2005	204	NoContent	No content found for given parameter	Request is processed successfully, but no data/content returned.
API2006	500	InternalServerError	Error occured while processing request	The server encountered an error while processing your request and failed.	Please contact Sikka API Support.
API2007	401	Unauthorized	Authentication/Authorization Failed	You are not authorized to access practice details with Sikka API.	This error can be caused when you try to access practice details not accessible by you. If you want to access this practice's details with Sikka API contact practice and ask to allow access.
API2009	404	NotFound	Resource not found	The resource you requested does not exist.	The resource you requested does not exist.
API4001	200	OK
API4002	200	OK	Error while decrypting string	Error occured due to invalid character in encrypted string or invalid passkey or bytekey.	Please check passkey/bytekey, encode encrypted string with URL Encoding to replace invalid characters.
API4003	200	OK	Error while decrypting password	Error occured due to invalid character in encrypted password or length, invalid passkey or bytekey.	Please check passkey/bytekey, encode encrypted password with URL Encoding to replace invalid characters.
API4004	200	OK	Error while decrypting email or username	Error occured due to invalid character in encrypted email/username or length, invalid passkey or bytekey.	Please check passkey/bytekey, encode encrypted email/username with URL Encoding to replace invalid characters.
API4005	200	OK	Error while decrypting verification code	Error occured due to invalid character in encrypted verification code or length, invalid passkey or bytekey.	Please check passkey/bytekey, encode encrypted verification code with URL Encoding to replace invalid characters.
API4001	200	OK
API4007	200	OK
API2010	500	InternalServerError	Data not uploaded for this customer	The data has not yet been uploaded for this customer. If it has been more than 4 hours since the installation, please contact Sikka Support for assistance.	Please contact Sikka Support.
API2011	429	Too Many Requests	Data limit exceeded	Data size per practice per day exceeded	Please make request to the datalimit API for more information.
API2012	429	Too Many Requests	Request limit exceeded	Requests per practice per day exceeded	Please make request to the datalimit API for more information.
API2013	409	Conflict	Resource already exists	You attempted to do something which would leave a resource in an inconsistent state, such as create a resource with an already taken name or id.	Please check name or id and resubmit the request again.
API2015	409	Conflict	Resource already exists	You attempted to do something which would leave a resource in an inconsistent state, such as create a resource with an already taken un or cell.	Please check un or cell and resubmit the request again.
API2016	201	Created	New resource created successfully
API2018	410	Gone
API2019	422	Unprocessable		The request was unable to be processed due to it containing invalid parameters.
API2014	405	Method Not Allowed	Method not allowed for the resource	Requested method not allowed for the resource	Please contact Sikka API support
API2017	412	Precondition Failed	The server does not meet one of the preconditions that the requester put on the request.	--	--

Webhooks

Webhooks allow you to set up your Apps which subscribe to certain events on practice data or Sikka Platform Cloud. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to update your production server or CI builds and let you know about latest activity. \nOnce webhook configured , the webhook will be triggered each time one or more subscribed events occurs.\nYou can create up to 2 webhooks for each event on each target

\n
$\"webhook$ \n $\"webhook$
\n

Webhooks require a few configuration options before you use of them.

Payload URL

This is your server endpoint that will receive the webhook payload.\nFor example , you want to received events on
https://<yourwebsitename>/api/receieve_payload\nOr \nhttps://<yourwebsitename>/api/payload

Content Type

At current Sikka Webhooks can be delivered using json format:\nThe application/json content type will deliver the JSON payload directly as the body of the POST.

Events

When configuring a webhook, you can choose which events you would like to receive payloads for. Only subscribing to the specific events you plan on handling is useful for limiting the number of HTTP requests to your server. You can change the list of subscribed events through the UI anytime. \nEach event corresponds to a certain set of actions that can happen to practice data or Sikka Platform Cloud. \nFor example, if you subscribe to the Data Refresh event you'll receive detailed payloads every time when Sikka Practice Utility data refresh completed\nTo create webhook , log in to Sikka API portal. Click on webhook. Enter required information and click on Add Webhook, it's time to check on your server to test the if events are receiving or not.

The available events are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
`Data_Refresh`	This indicates local SPC refresh is completed and data be available via API
`patient`	When practice chang patient records , new patient added or deleted , this event will trigger.
`transaction`	Coming Soon
`appointments`	Coming Soon
==Note : Sikka Practice Utility has to be up and running on server for all events==

Payloads

Each event type has a specific payload format with the relevant event information. \nIn addition to the fields documented for each event, webhook payloads include the office_id , practice_id on which the event occurred on

Headers

HTTP POST payloads that are delivered to your webhook's configured URL endpoint will contain several headers:\nExample delivery

POST /payload HTTP/1.1\nHost: <host>\nX-API-callback-key: xxxxxxxxx\nContent-Type: application/json\nContent-Length: 6615\n{\n BODY\n}\n

Webhook payload example

Data_refresh :

{\n    \"event\": \"Data_Refresh\",\n    \"office_id\": \"D24710\",\n    \"practice_id\": 1,\n    \"data_synchronization_date\": \"2018-04-04 17:03:07\",\n    \"practice_management_system_refresh_date\": \"2018-04-04 17:01:21\",\n    \"financial_system_refresh_date\": \"1111-11-11\",\n    \"web_upload_date\": \"2018-04-04 17:03:07\",\n    \"data_insert_date\": \"2018-04-04 17:11:34\",\n    \"practice_management_system_refresh_date_time_zone\": \"Eastern Standard Time\",\n    \"practice_management_system\": \"Dentrix\",\n    \"practice_management_system_version\": \"V16.6\",\n    \"financial_system\": \"\",\n    \"financial_system_version\": \"\",\n    \"utc_difference_in_minutes\": \"240\",\n    \"spc_schedule_time\": \"5:00 PM\",\n    \"spc_schedule_type\": \"Daily\"\n}\n

Patient :

{\n    \"event\": \"patient\",\n    \"office_id\": \"D20226\",\n    \"practice_id\": \"1\",\n    \"generated_time\": \"2018-04-04 17:06:00\"\n}\n

List of APIs

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"Quickstart","slug":"quickstart"},{"content":"API Field Filtering","slug":"api-field-filtering"},{"content":"Expanding Objects","slug":"expanding-objects"},{"content":"Pagination","slug":"pagination"},{"content":"Modified Records","slug":"modified-records"},{"content":"Output Formats","slug":"output-formats"},{"content":"HTTP Compression","slug":"http-compression"},{"content":"Error Codes","slug":"error-codes"},{"content":"Webhooks","slug":"webhooks"},{"content":"List of APIs","slug":"list-of-apis"}],"owner":"3967924","collectionId":"0490415e-f59c-4557-99c2-ecbf686a6234","publishedId":"RW1dExDy","public":true,"customColor":null,"publishDate":"2018-05-01T17:20:41.000Z"},"item":[{"name":"Authentication API","item":[{"name":"applications","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"request_key\", jsonData[0].request_key);\r","\r","\r","tests[\"start\"] = responseCode.code === 200;"]}}],"id":"9e993e00-7647-4968-b69c-ded91e672275","request":{"method":"GET","header":[],"url":"{{authurl}}/applications?app_id={{app_id}}&app_key={{app_key}}","description":"

This endpoint will return the application details. Including developers assign to this applications , allowed APIs list and other information.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required
app_id	This is the ID assigned to the application when the application is registered on API portal	Yes
app_key	This is the unique key generated when the application is registered on API portal	Yes

","urlObject":{"path":["applications"],"host":["{{authurl}}"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"}],"variable":[]}},"response":[{"id":"0b0dd12e-65ac-4cb0-b690-c83af1d3740e","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{authurl}}/applications?app_id={{app_id}}&app_key={{app_key}}","host":["{{authurl}}"],"path":["applications"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","name":"Access-Control-Allow-Methods","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private","name":"Cache-Control","description":""},{"key":"Cache-control","value":"no-cache=\"set-cookie\"","name":"Cache-control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"724","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 25 Apr 2017 23:30:29 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"Set-Cookie","value":"AWSELB=9BC9DF5B1EBBA968D8DEF4EFAE98B9151A1F2918EDD932BA532722CED5F7401EC830205BFF7DECDA5BA0EB836EF66A5C1B610D6800639ED13A5163E99921596CFE61FCCD79;PATH=/;MAX-AGE=600","name":"Set-Cookie","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"api.sikkasoft.com","path":"/","secure":false,"value":"9BC9DF5B1EBBA968D8DEF4EFAE98B9151A1F2918EDD932BA532722CED5F7401EC830205BFF7DECDA5BA0EB836EF66A5C1B610D6800639ED13A5163E99921596CFE61FCCD79","key":"AWSELB"}],"responseTime":null,"body":"{\n \"app_id\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"name\": \"BETA API TEST\",\n \"registration_date\": \"2016-11-07\",\n \"activation_date\": \"2016-11-07\",\n \"expiry_date\": \"\",\n \"status\": \"verified\",\n \"description\": \"testing BETA SIKKASOFT APIs\",\n \"website\": \"https://www.sikkasoft.com\",\n \"scope\": \"all\",\n \"parent_master_customer_id\": \"\",\n \"logo\": \"\",\n \"developers\": [\n {\n \"user_name\": \"test@sikkasoft.com\",\n \"developer_id\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"registration_date\": \"3/28/2012 2:28:50 PM\",\n \"status\": \"active\",\n \"name\": \"Sikka Admin\",\n \"address_line1\": \"830 Hillview Court\",\n \"address_line2\": \"Suite 290\",\n \"cell\": \"xxxxxxxxxx\",\n \"city\": \"Milpitas\",\n \"country\": \"United States\",\n \"parent_developer_id\": \"\",\n \"phone\": \"xxxxxxxxxx\",\n \"state\": \"CA\",\n \"user_type\": \"Super Admin\",\n \"zipcode\": \"95035\"\n }\n ]\n}"}],"_postman_id":"9e993e00-7647-4968-b69c-ded91e672275"},{"name":"list of authorized practices","id":"dcaf85b0-2bc5-4699-8bb8-c645297d2452","request":{"method":"GET","header":[],"url":"{{authurl}}/authorized_practices?app_id={{app_id}}&app_key={{app_key}}","description":"

Return the list of practices ; your application authorized to access data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required
app_id	This is the ID assigned to the application when the application is registered on API portal	Yes
app_key	This is the unique key generated when the application is registered on API portal	Yes
practice_management_system_refresh_date_time_zone	Time Zone	No
show	Possible value for this parameter is \"all\" to show all practices	No
practice_id	Practice ID, only works when show=all used	No

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Note
`office_id`	Unique office id in Sikka system. This will require in `start` API call
`secret_key`	Unique secret key of office in Sikka system. This will require in `start` API call
`domain`	domain / vertical of practice
`practice_name`	Name of practice when user signed up for Sikka account
`practice_management_system`	Practice management system of practice.
`financial_system`	Financial system of practice when user signed up for Sikka account
`practice_management_system_refresh_date`	This date indicates when SPC has sync. with practice management system.This is local time as per practice location. see below `practice_management_system_refresh_date_time_zone`
`data_synchronization_date`	This date indicates when SPC has sync. with sikka cloud database. This is local time as per practice location. see below `practice_management_system_refresh_date_time_zone`
`data_insert_date`	This date indicates when practice management system data inserted into sikka cloud database.This date shows latest data updated date. This is local time as per practice location. see below `practice_management_system_refresh_date_time_zone`
`practice_management_system_refresh_date_time_zone`	Time zone of practice location.
`practice_id`	practice_id(Location ID) of the practice for office id in Sikka system.

\n
To make sure practice data is updated or not : check data_insert_date . if data_insert_date is latest or greater then last data insert date that means practice data is updated successfully. If data_insert_date is old or not changing please refresh SPC on client location.
\n

\n","urlObject":{"path":["authorized_practices"],"host":["{{authurl}}"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"}],"variable":[]}},"response":[{"id":"6f45207e-12f7-4a51-9b9c-eaf9f9a8e8b3","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{authurl}}/authorized_practices?app_id={{app_id}}&app_key={{app_key}}","host":["{{authurl}}"],"path":["authorized_practices"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private","name":"Cache-Control","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Length","value":"676","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 03 May 2017 20:42:21 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"500\",\n \"total_count\": \"2\",\n \"items\": [\n {\n \"office_id\": \"xxxxx\",\n \"domain\": \"Dental\",\n \"href\": \"https://api.sikkasoft.com/auth/v2/authorized_practices/xxxxx\",\n \"secret_key\": \"xxxxxxxxxxxxxxxxxxx\",\n \"practice_name\": \"Demo Dental Care Testing Internal Use Only\",\n \"address\": \"121 Main Street\",\n \"city\": \"San Jose\",\n \"state\": \"CA\",\n \"zip\": \"95335\",\n \"practice_management_system\": \"Dentrix\",\n \"financial_system\": \"\",\n \"practice_management_system_refresh_date\": \"2017-03-23 12:09:10\",\n \"data_synchronization_date\": \"1900-01-01 00:00:00\",\n \"data_insert_date\": \"2017-03-23 12:56:01\",\n \"practice_management_system_version\": \"V16.2\",\n \"practice_management_system_refresh_date_time_zone\": \"India Standard Time\",\n \"practice_id\": \"1\"\n },\n {\n \"office_id\": \"xxxxx\",\n \"domain\": \"Veterinary\",\n \"href\": \"https://api.sikkasoft.com/auth/v2/authorized_practices/xxxxx\",\n \"secret_key\": \"xxxxxxxxxxxxxxxxxxx\",\n \"practice_name\": \"SikkaAPI Vet Demo\",\n \"address\": \"Street 123\",\n \"city\": \"San JOse\",\n \"state\": \"CA\",\n \"zip\": \"95116\",\n \"practice_management_system\": \"\",\n \"financial_system\": \"\",\n \"practice_management_system_refresh_date\": \"\",\n \"data_synchronization_date\": \"\",\n \"data_insert_date\": \"\",\n \"practice_management_system_version\": \"\",\n \"practice_management_system_refresh_date_time_zone\": \"\",\n \"practice_id\": \"1\"\n }\n ]\n }\n]"},{"id":"76e059c6-9697-4a56-9d9d-72a7b1c7ac23","name":"list of authorized practices with show=all","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{authurl}}/authorized_practices?app_id={{app_id}}&app_key={{app_key}}&show=all&practice_id={practice_id}","host":["{{authurl}}"],"path":["authorized_practices"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"},{"key":"show","value":"all"},{"key":"practice_id","value":"{practice_id}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"offset\": \"0\",\r\n \"limit\": \"500\",\r\n \"total_count\": \"2\",\r\n \"items\": [\r\n {\r\n \"office_id\": \"xxxxx\",\r\n \"domain\": \"Dental\",\r\n \"href\": \"https://api.sikkasoft.com/auth/v2/authorized_practices/xxxxx\",\r\n \"secret_key\": \"xxxxxxxxxxxxxxxxxxx\",\r\n \"practice_name\": \"Demo Dental Care Testing Internal Use Only\",\r\n \"address\": \"121 Main Street\",\r\n \"city\": \"San Jose\",\r\n \"state\": \"CA\",\r\n \"zip\": \"95335\",\r\n \"practice_management_system\": \"Dentrix\",\r\n \"financial_system\": \"\",\r\n \"practice_management_system_refresh_date\": \"2017-03-23 12:09:10\",\r\n \"data_synchronization_date\": \"1900-01-01 00:00:00\",\r\n \"data_insert_date\": \"2017-03-23 12:56:01\",\r\n \"practice_management_system_version\": \"V16.2\",\r\n \"practice_management_system_refresh_date_time_zone\": \"India Standard Time\",\r\n\t\t\"practice_id\": \"1\"\r\n },\r\n {\r\n \"office_id\": \"xxxxx\",\r\n \"domain\": \"Veterinary\",\r\n \"href\": \"https://api.sikkasoft.com/auth/v2/authorized_practices/xxxxx\",\r\n \"secret_key\": \"xxxxxxxxxxxxxxxxxxx\",\r\n \"practice_name\": \"SikkaAPI Vet Demo\",\r\n \"address\": \"Street 123\",\r\n \"city\": \"San JOse\",\r\n \"state\": \"CA\",\r\n \"zip\": \"95116\",\r\n \"practice_management_system\": \"\",\r\n \"financial_system\": \"\",\r\n \"practice_management_system_refresh_date\": \"\",\r\n \"data_synchronization_date\": \"\",\r\n \"data_insert_date\": \"\",\r\n \"practice_management_system_version\": \"\",\r\n \"practice_management_system_refresh_date_time_zone\": \"\",\r\n\t\t\"practice_id\": \"2\"\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"dcaf85b0-2bc5-4699-8bb8-c645297d2452"},{"name":"list of authorized practices by office id","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Response time is less than 200ms\"] = responseTime < 200;","","tests[\"Status code is 200\"] = responseCode.code === 200;"]}}],"id":"b8fbfd6b-433b-4697-a8db-d1a653e85444","request":{"method":"GET","header":[],"url":"{{authurl}}/authorized_practices/{{office_id}}?app_id={{app_id}}&app_key={{app_key}}","description":"

Return the practice information, your application authorized to access data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required
app_id	This is the ID assigned to the application when the application is registered on API portal	Yes
app_key	This is the unique key generated when the application is registered on API portal	Yes
show	Possible value for this parameter is \"all\" to show all practices	No
practice_id	Practice ID, only works when show=all used	No

","urlObject":{"path":["authorized_practices","{{office_id}}"],"host":["{{authurl}}"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"}],"variable":[]}},"response":[{"id":"2569b8b6-18f6-42de-9157-d3f367eeaae7","name":"list of authorized practices by office id with show=all","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{authurl}}/authorized_practices/{{office_id}}?app_id={{app_id}}&app_key={{app_key}}&show=all&practice_id={practice_id}","host":["{{authurl}}"],"path":["authorized_practices","{{office_id}}"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"},{"key":"show","value":"all"},{"key":"practice_id","value":"{practice_id}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"offset\": \"0\",\r\n \"limit\": \"500\",\r\n \"total_count\": \"2\",\r\n \"items\": [\r\n {\r\n \"office_id\": \"xxxxx\",\r\n \"domain\": \"Dental\",\r\n \"href\": \"https://api.sikkasoft.com/auth/v2/authorized_practices/xxxxx\",\r\n \"secret_key\": \"xxxxxxxxxxxxxxxxxxx\",\r\n \"practice_name\": \"Demo Dental Care Testing Internal Use Only\",\r\n \"address\": \"121 Main Street\",\r\n \"city\": \"San Jose\",\r\n \"state\": \"CA\",\r\n \"zip\": \"95335\",\r\n \"practice_management_system\": \"Dentrix\",\r\n \"financial_system\": \"\",\r\n \"practice_management_system_refresh_date\": \"2017-03-23 12:09:10\",\r\n \"data_synchronization_date\": \"1900-01-01 00:00:00\",\r\n \"data_insert_date\": \"2017-03-23 12:56:01\",\r\n \"practice_management_system_version\": \"V16.2\",\r\n \"practice_management_system_refresh_date_time_zone\": \"India Standard Time\",\r\n\t\t\"practice_id\": \"1\"\r\n },\r\n {\r\n \"office_id\": \"xxxxx\",\r\n \"domain\": \"Veterinary\",\r\n \"href\": \"https://api.sikkasoft.com/auth/v2/authorized_practices/xxxxx\",\r\n \"secret_key\": \"xxxxxxxxxxxxxxxxxxx\",\r\n \"practice_name\": \"SikkaAPI Vet Demo\",\r\n \"address\": \"Street 123\",\r\n \"city\": \"San JOse\",\r\n \"state\": \"CA\",\r\n \"zip\": \"95116\",\r\n \"practice_management_system\": \"\",\r\n \"financial_system\": \"\",\r\n \"practice_management_system_refresh_date\": \"\",\r\n \"data_synchronization_date\": \"\",\r\n \"data_insert_date\": \"\",\r\n \"practice_management_system_version\": \"\",\r\n \"practice_management_system_refresh_date_time_zone\": \"\",\r\n\t\t\"practice_id\": \"2\"\r\n }\r\n ]\r\n }\r\n]"},{"id":"ca8d5982-0675-4656-9d3d-f6f95b926f7c","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{authurl}}/authorized_practices/{{office_id}}?app_id={{app_id}}&app_key={{app_key}}","host":["{{authurl}}"],"path":["authorized_practices","{{office_id}}"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Content-Encoding","key":"Content-Encoding","value":"gzip","description":""},{"name":"Content-Length","key":"Content-Length","value":"411","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 16 Jun 2017 07:25:06 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"Vary","key":"Vary","value":"Accept-Encoding","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"office_id\": \"xxxxx\",\n \"domain\": \"Dental\",\n \"href\": \"https://api.sikkasoft.com/auth/v2/authorized_practices/xxxxx\",\n \"secret_key\": \"xxxxxxxxxxxxxxxxxxx\",\n \"practice_name\": \"Loadtest Dental\",\n \"address\": \"San jose\",\n \"city\": \"San Jose\",\n \"state\": \"California\",\n \"zip\": \"95011\",\n \"practice_management_system\": \"\",\n \"financial_system\": \"\",\n \"practice_management_system_refresh_date\": \"\",\n \"data_synchronization_date\": \"\",\n \"data_insert_date\": \"\",\n \"practice_management_system_version\": \"\",\n \"practice_management_system_refresh_date_time_zone\": \"\",\n \"practice_id\": \"1\"\n}"}],"_postman_id":"b8fbfd6b-433b-4697-a8db-d1a653e85444"},{"name":"request_key_info","id":"81a63a53-8e94-42ee-b137-d8ae7545b239","request":{"method":"GET","header":[],"url":"{{url}}/request_key_info?request_key={{request_key}}","description":"

Accepts an request key and returns information about that request key including which office id was it issued to, the intended target of the request key, the scopes the user consented to, the remaining lifetime of the request key.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes

","urlObject":{"path":["request_key_info"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"ae9e001a-3eed-4f72-a768-dfeba4a0e0ef","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/request_key_info?request_key={{request_key}}","host":["{{url}}"],"path":["request_key_info"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"312","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:41:18 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"href\": \"https://api.sikkasoft.com/v2/request_key_info?request_key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"request_key\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"start_time\": \"4/26/2017 8:59:06 AM\",\n \"end_time\": \"\",\n \"expires_in\": \"1068 second(s)\",\n \"issued_to\": \"xxxxx\",\n \"status\": \"active\",\n \"request_count\": \"50\",\n \"scope\": \"all\"\n}"}],"_postman_id":"81a63a53-8e94-42ee-b137-d8ae7545b239"},{"name":"request_key","id":"68704293-c732-4373-a761-bb65c7943f60","request":{"method":"GET","header":[],"url":"{{authurl}}/request_keys?app_id={{app_id}}&app_key={{app_key}}&office_id={{office_id}}&secret_key={{secret_key}}","description":"

Generate the request keys. This API is same as start API call . Both are same

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
app_id	This is the ID assigned to the application when the application is registered on API portal	Yes
app_key	This is the unique key generated when the application is registered on API portal	Yes
office_id	Mastercustomerid, This is the ID assigned to a practice when that practice is added	Yes
secret_key	This is the Secrete Key generated for that practice, when practice is added	Yes

","urlObject":{"path":["request_keys"],"host":["{{authurl}}"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"},{"key":"office_id","value":"{{office_id}}"},{"key":"secret_key","value":"{{secret_key}}"}],"variable":[]}},"response":[{"id":"9ebd8356-4cd5-4436-8e79-a0215560ab92","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{authurl}}/request_keys?app_id={{app_id}}&app_key={{app_key}}&office_id={{office_id}}&secret_key={{secret_key}}","host":["{{authurl}}"],"path":["request_keys"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"},{"key":"office_id","value":"{{office_id}}"},{"key":"secret_key","value":"{{secret_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private","name":"Cache-Control","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Length","value":"250","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 03 May 2017 21:53:59 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"scope\": \"https://api.sikkasoft.com/v2/\",\n \"request_key\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"token_type\": \"Bearer\",\n \"expires_in\": \"86400\"\n}"}],"_postman_id":"68704293-c732-4373-a761-bb65c7943f60"},{"name":"list of all request keys made by application","id":"4ec22b4b-140f-4d45-be75-a4a019c42489","request":{"method":"GET","header":[],"url":"{{authurl}}/request_keys_details?app_id={{app_id}}&app_key={{app_key}}","description":"

Accepts application id and application key and returns information about all the API calls made by application in last 24 hrs. It contains request keys , api name , response time , data size , time , request status , parameters , response time per request_key.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
app_id	This is the ID assigned to the application when the application is registered on API portal	Yes
app_key	This is the unique key generated when the application is registered on API portal	Yes

","urlObject":{"path":["request_keys_details"],"host":["{{authurl}}"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"}],"variable":[]}},"response":[{"id":"16882cff-6d11-43b8-a82a-67cd5b6fc246","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{authurl}}/request_keys_details?app_id={{app_id}}&app_key={{app_key}}","host":["{{authurl}}"],"path":["request_keys_details"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private","name":"Cache-Control","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Length","value":"596","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 03 May 2017 21:59:30 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"500\",\n \"total_count\": \"2\",\n \"items\": [\n {\n \"request_key\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"api\": \"start\",\n \"time\": \"5/3/2017 9:53:59 PM\",\n \"response_time_ms\": \"62\",\n \"datasize_bytes\": \"139\",\n \"request_ip\": \"24.104.64.134\",\n \"parameters\": \"app_id=aU839ROq32PD58vUAFcssWoPPf6tHxtcIH8LpYcgYFASScM0mQBX/A==&app_key=uoVEPwnh9M63DKdgOsoh8DvPOCCSEIoPVqf30x/YSzsSScM0mQBX/A==&office_id=Ww+/CHlJiig=&secret_key=afRpggkgf9AT1G9s7XV9gmXnv0kLjeLd\",\n \"request_status\": \"success\",\n \"type\": \"json\"\n },\n {\n \"request_key\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"api\": \"start\",\n \"time\": \"5/3/2017 9:59:28 PM\",\n \"response_time_ms\": \"32\",\n \"datasize_bytes\": \"139\",\n \"request_ip\": \"24.104.64.134\",\n \"parameters\": \"app_id=aU839ROq32PD58vUAFcssWoPPf6tHxtcIH8LpYcgYFASScM0mQBX/A==&app_key=uoVEPwnh9M63DKdgOsoh8DvPOCCSEIoPVqf30x/YSzsSScM0mQBX/A==&office_id=Ww+/CHlJiig=&secret_key=afRpggkgf9AT1G9s7XV9gmXnv0kLjeLd\",\n \"request_status\": \"success\",\n \"type\": \"json\"\n }\n ]\n }\n]"}],"_postman_id":"4ec22b4b-140f-4d45-be75-a4a019c42489"},{"name":"reset password","id":"39e69c98-e9f9-4698-bf4f-1f0de3a4d494","request":{"method":"GET","header":[],"url":"{{authurl}}/reset_password?account_type=provider&pw={new password}&app_id={{app_id}}&app_key={{app_key}}&email={account owner 's email}&vcode={verification code}&encrypted={true/false}","description":"

The reset_password API is used to change the password, after getting the verification code. After app request API to send verification code.In next step user should pass encrypted verification code and encrypted new password via reset_password API. This API will check for verification code and if it is correct then changes the password to the new one, or error message will be given. After password change user can log in with new password.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
app_id	This is the ID assigned to the application when the application is registered on API portal	Yes
app_key	This is the unique key generated when the application is registered on API portal	Yes
account_type	provider or patient	Yes
pw	Password. Use this parameter's value after encryption. please check the encrypt API call to encrypt value.	Yes
email	Email id of patient / provider	Yes
vcode	verification code. Encrypt verification code before passing to request	Yes
encrypted	Encrypted is string variable. It can be “true” or “false”. Default value is “true”. If you want to send encrypted username , password , verification code then set encrypted=true otherwise for plain text set it encrypted=false	No

","urlObject":{"path":["reset_password"],"host":["{{authurl}}"],"query":[{"key":"account_type","value":"provider"},{"key":"pw","value":"{new password}"},{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"},{"key":"email","value":"{account owner 's email}"},{"key":"vcode","value":"{verification code}"},{"key":"encrypted","value":"{true/false}"}],"variable":[]}},"response":[{"id":"ab56dac3-6fbd-44b9-b942-3897f5daa29d","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{authurl}}/reset_password?account_type=provider&pw={new password}&app_id={{app_id}}&app_key={{app_key}}&email={account owner 's email}&vcode={verification code}&encrypted={true/false}","host":["{{authurl}}"],"path":["reset_password"],"query":[{"key":"account_type","value":"provider"},{"key":"pw","value":"{new password}"},{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"},{"key":"email","value":"{account owner 's email}"},{"key":"vcode","value":"{verification code}"},{"key":"encrypted","value":"{true/false}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private","name":"Cache-Control","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Length","value":"266","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 03 May 2017 22:13:58 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"{\"http_code\":\"200\",\"http_code_desc\":\"OK\",\"sikka_status_code\":\"API4001\",\"short_message\":\"\",\"long_message\":\" Password changed successfully. You can login with new password.\",\"more_information\":\"\"}\r\n"}],"_postman_id":"39e69c98-e9f9-4698-bf4f-1f0de3a4d494"},{"name":"detail activity about perticular request_key","id":"41139030-bb21-4d5a-8e07-e00fa4ff5178","request":{"method":"GET","header":[],"url":"{{authurl}}/request_keys_details/{{request_key}}?app_id={{app_id}}&app_key={{app_key}}","description":"

Accepts application id and application key and returns detail activity information about all the API calls made by request key in last 24 hrs. It contains api name , response time , data size , time , request status , parameters , response time per request_key.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
app_id	This is the ID assigned to the application when the application is registered on API portal	Yes
app_key	This is the unique key generated when the application is registered on API portal	Yes

","urlObject":{"path":["request_keys_details","{{request_key}}"],"host":["{{authurl}}"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"}],"variable":[]}},"response":[{"id":"b8464f5b-ff6a-42e5-8913-1e3d67172602","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{authurl}}/request_keys_details/{{request_key}}?app_id={{app_id}}&app_key={{app_key}}","host":["{{authurl}}"],"path":["request_keys_details","{{request_key}}"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private","name":"Cache-Control","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Length","value":"598","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 03 May 2017 22:05:05 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"500\",\n \"total_count\": \"2\",\n \"items\": [\n {\n \"request_key\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"api\": \"start\",\n \"time\": \"5/3/2017 9:59:28 PM\",\n \"response_time_ms\": \"32\",\n \"datasize_bytes\": \"139\",\n \"request_ip\": \"24.104.64.134\",\n \"parameters\": \"app_id=aU839ROq32PD58vUAFcssWoPPf6tHxtcIH8LpYcgYFASScM0mQBX/A==&app_key=uoVEPwnh9M63DKdgOsoh8DvPOCCSEIoPVqf30x/YSzsSScM0mQBX/A==&office_id=Ww+/CHlJiig=&secret_key=afRpggkgf9AT1G9s7XV9gmXnv0kLjeLd\",\n \"request_status\": \"success\",\n \"type\": \"json\"\n },\n {\n \"request_key\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"api\": \"transactions\",\n \"time\": \"5/3/2017 10:05:00 PM\",\n \"response_time_ms\": \"550\",\n \"datasize_bytes\": \"619239\",\n \"request_ip\": \"24.104.64.134\",\n \"parameters\": \"request_key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"request_status\": \"success\",\n \"type\": \"json\"\n }\n ]\n }\n]"}],"_postman_id":"41139030-bb21-4d5a-8e07-e00fa4ff5178"},{"name":"send verification code","id":"fe6fbcb6-7b6e-4e34-9480-187c320419ec","request":{"method":"GET","header":[],"url":"{{authurl}}/send_verification_code?account_type={account_type}&un={username}&app_id={{app_id}}&app_key={{app_key}}&encrypted={true/false}","description":"

To change or reset the Sikka account password. First you need to send the verification code to user. User will receive the verification code and you can use that code in reset_password API

\n","urlObject":{"path":["send_verification_code"],"host":["{{authurl}}"],"query":[{"key":"account_type","value":"{account_type}"},{"key":"un","value":"{username}"},{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"},{"key":"encrypted","value":"{true/false}"}],"variable":[]}},"response":[{"id":"b419c7a9-4ff5-424f-b20b-ba94b66ddf07","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{authurl}}/send_verification_code?account_type={account_type}&un={username}&app_id={{app_id}}&app_key={{app_key}}&encrypted={true/false}","host":["{{authurl}}"],"path":["send_verification_code"],"query":[{"key":"account_type","value":"{account_type}"},{"key":"un","value":"{username}"},{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"},{"key":"encrypted","value":"{true/false}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private","name":"Cache-Control","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Length","value":"279","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 03 May 2017 22:10:35 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"{\"http_code\":\"200\",\"http_code_desc\":\"OK\",\"sikka_status_code\":\"API4001\",\"short_message\":\"\",\"long_message\":\"Verification code sent to 'demo@sikkasoftware.com'. Please check your inbox for code.\",\"more_information\":\"\"}\r\n"}],"_postman_id":"fe6fbcb6-7b6e-4e34-9480-187c320419ec"},{"name":"sikka practice utility details","id":"1506f5e6-f3c3-47b4-871c-f9dd1987e3a1","request":{"method":"GET","header":[],"url":"https://api.sikkasoft.com/auth/v2/sikka_practice_utility_details?app_id={app_id}&app_key={app_key}","description":"

This API gives detail results about SPC.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
app_id	This is the ID assigned to the application when the application is registered on API portal	Yes
app_key	This is the unique key generated when the application is registered on API portal	Yes

","urlObject":{"protocol":"https","path":["auth","v2","sikka_practice_utility_details"],"host":["api","sikkasoft","com"],"query":[{"key":"app_id","value":"{app_id}"},{"key":"app_key","value":"{app_key}"}],"variable":[]}},"response":[{"id":"05618c64-0833-4c81-a778-d52c5e8b37b5","name":"sample","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sikkasoft.com/auth/v2/sikka_practice_utility_details?app_id={app_id}&app_key={app_key}","protocol":"https","host":["api","sikkasoft","com"],"path":["auth","v2","sikka_practice_utility_details"],"query":[{"key":"app_id","value":"{app_id}"},{"key":"app_key","value":"{app_key}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Content-Encoding","key":"Content-Encoding","value":"gzip","description":""},{"name":"Content-Length","key":"Content-Length","value":"1236","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Sat, 22 Jul 2017 05:03:58 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"Vary","key":"Vary","value":"Accept-Encoding","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"500\",\n \"total_count\": \"55\",\n \"items\": [\n {\n \"office_id\": \"A5138\",\n \"href\": \"https://api.sikkasoft.com/auth/v2/sikka_practice_utility_details/A5138\",\n \"spc_id\": \"11573\",\n \"practice_id\": \"3\",\n \"refresh_time\": \"2015-01-14 15:58:47\",\n \"teamviwer_id\": \"586172796\",\n \"teamviwer_version\": \"TeamViewer7\",\n \"spc_version\": \"\",\n \"practice_management_system\": \"Sycle.Net\",\n \"practice_management_system_version\": \"Web\",\n \"practice_management_system_version_detected\": \"\",\n \"practice_management_system_data_path\": \"D:\\\\\",\n \"financial_management_system\": \"\",\n \"financial_management_system_version\": \"\",\n \"financial_management_system_version_detected\": \"\",\n \"financial_management_system_data_path\": \"\",\n \"spc_schedule_time\": \"2:00 AM\",\n \"spc_schedule_type\": \"Daily\",\n \"spc_schedule_interval\": \"6 Hours\",\n \"is_spc_update_locked\": \"False\",\n \"spc_update_lock_note\": \"\",\n \"last_spc_updated_checked\": \"\",\n \"is_delta_import_enable\": \"False\",\n \"etl_start\": \"2015-01-14 15:45:04\",\n \"etl_end\": \"2015-01-14 15:54:57\",\n \"web_upload_start\": \"2015-01-14 15:55:11\",\n \"web_upload_end\": \"2015-01-14 15:58:47\",\n \"local_upload_start\": \"2015-01-14 15:55:11\",\n \"local_upload_end\": \"2015-01-14 15:55:11\",\n \"financial_etl_start\": \"2015-01-14 14:00:06\",\n \"financial_etl_end\": \"2015-01-14 14:00:06\",\n \"etl_error_log\": \"\",\n \"etl_error_priority\": \"\",\n \"etl_error_description\": \"\",\n \"etl_cpu_utilization\": \"\",\n \"etl_memory_utilization\": \"\",\n \"financial_error_priority\": \"\",\n \"financial_error_description\": \"\",\n \"financial_etl_cpu_utilization\": \"\",\n \"financial_etl_memory_utilization\": \"\",\n \"local_insert_error_log\": \"\",\n \"local_insert_error_priority\": \"\",\n \"local_insert_cpu_utilization\": \"2.32361584878561\",\n \"local_insert_memory_utilization\": \"80269312\",\n \"local_upload_error_description\": \"\",\n \"web_upload_error_flag\": \"\",\n \"web_upload_error_priority\": \"\",\n \"web_upload_bandwidth_utilization\": \"492832\",\n \"web_upload_error_description\": \"\",\n \"upload_to_server\": \"2015-01-14 10:29:55\",\n \"upload_to_client\": \"2015-01-14 15:59:10\",\n \"domain\": \"Audiology\",\n \"spc_error_flag\": \"\",\n \"spc_error_priority\": \"\",\n \"spc_error_description\": \"\",\n \"timezone\": \"\",\n \"is_etl_edk\": \"\",\n \"etl_version\": \"\"\n },\n {\n \"office_id\": \"A6156\",\n \"href\": \"https://api.sikkasoft.com/auth/v2/sikka_practice_utility_details/A6156\",\n \"spc_id\": \"8669\",\n \"practice_id\": \"1\",\n \"refresh_time\": \"2015-09-05 08:32:39\",\n \"teamviwer_id\": \"681882497\",\n \"teamviwer_version\": \"TeamViewer8\",\n \"spc_version\": \"3.3.0.1\",\n \"practice_management_system\": \"Tims\",\n \"practice_management_system_version\": \"V5.0\",\n \"practice_management_system_version_detected\": \"\",\n \"practice_management_system_data_path\": \"SERVER\\\\TIMS\",\n \"financial_management_system\": \"\",\n \"financial_management_system_version\": \"\",\n \"financial_management_system_version_detected\": \"\",\n \"financial_management_system_data_path\": \"\",\n \"spc_schedule_time\": \"2:00 AM\",\n \"spc_schedule_type\": \"Daily\",\n \"spc_schedule_interval\": \"6 Hours\",\n \"is_spc_update_locked\": \"False\",\n \"spc_update_lock_note\": \"\",\n \"last_spc_updated_checked\": \"\",\n \"is_delta_import_enable\": \"True\",\n \"etl_start\": \"2015-09-05 08:30:14\",\n \"etl_end\": \"2015-09-05 08:30:16\",\n \"web_upload_start\": \"2015-09-05 08:30:16\",\n \"web_upload_end\": \"2015-09-05 08:32:39\",\n \"local_upload_start\": \"2015-09-05 08:30:16\",\n \"local_upload_end\": \"2015-09-05 08:30:16\",\n \"financial_etl_start\": \"2015-09-05 08:30:16\",\n \"financial_etl_end\": \"2015-09-05 08:30:16\",\n \"etl_error_log\": \"\",\n \"etl_error_priority\": \"\",\n \"etl_error_description\": \"\",\n \"etl_cpu_utilization\": \"0\",\n \"etl_memory_utilization\": \"0\",\n \"financial_error_priority\": \"\",\n \"financial_error_description\": \"\",\n \"financial_etl_cpu_utilization\": \"\",\n \"financial_etl_memory_utilization\": \"\",\n \"local_insert_error_log\": \"\",\n \"local_insert_error_priority\": \"\",\n \"local_insert_cpu_utilization\": \"0\",\n \"local_insert_memory_utilization\": \"51798016\",\n \"local_upload_error_description\": \"\",\n \"web_upload_error_flag\": \"\",\n \"web_upload_error_priority\": \"\",\n \"web_upload_bandwidth_utilization\": \"0\",\n \"web_upload_error_description\": \"\",\n \"upload_to_server\": \"2015-09-05 13:33:12\",\n \"upload_to_client\": \"2015-09-05 08:33:10\",\n \"domain\": \"Audiology\",\n \"spc_error_flag\": \"\",\n \"spc_error_priority\": \"\",\n \"spc_error_description\": \"\",\n \"timezone\": \"\",\n \"is_etl_edk\": \"\",\n \"etl_version\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"1506f5e6-f3c3-47b4-871c-f9dd1987e3a1"},{"name":"sikka practice utility details by office id","id":"dd70ae05-2c54-47a9-ae0d-576bd443e99d","request":{"method":"GET","header":[],"url":"https://api.sikkasoft.com/auth/v2/sikka_practice_utility_details/{office_id}?app_id={app_id}&app_key={app_key}","description":"

This API gives detail results about SPC by office id.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
app_id	This is the ID assigned to the application when the application is registered on API portal	Yes
app_key	This is the unique key generated when the application is registered on API portal	Yes

","urlObject":{"protocol":"https","path":["auth","v2","sikka_practice_utility_details","{office_id}"],"host":["api","sikkasoft","com"],"query":[{"key":"app_id","value":"{app_id}"},{"key":"app_key","value":"{app_key}"}],"variable":[]}},"response":[{"id":"3fb0f21d-691e-42ee-bbe2-46d858479abe","name":"sample","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sikkasoft.com/auth/v2/sikka_practice_utility_details/{office_id}?app_id={app_id}&app_key={app_key}","protocol":"https","host":["api","sikkasoft","com"],"path":["auth","v2","sikka_practice_utility_details","{office_id}"],"query":[{"key":"app_id","value":"{app_id}"},{"key":"app_key","value":"{app_key}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Content-Encoding","key":"Content-Encoding","value":"gzip","description":""},{"name":"Content-Length","key":"Content-Length","value":"874","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Sat, 22 Jul 2017 05:59:43 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"Vary","key":"Vary","value":"Accept-Encoding","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"500\",\"total_count\":\"1\",\"items\":[{\"office_id\":\"A5138\",\"href\":\"https:\\/\\/api.sikkasoft.com\\/auth\\/v2\\/sikka_practice_utility_details\\/A5138\",\"spc_id\":\"11573\",\"practice_id\":\"3\",\"refresh_time\":\"2015-01-14 15:58:47\",\"teamviwer_id\":\"586172796\",\"teamviwer_version\":\"TeamViewer7\",\"spc_version\":\"\",\"practice_management_system\":\"Sycle.Net\",\"practice_management_system_version\":\"Web\",\"practice_management_system_version_detected\":\"\",\"practice_management_system_data_path\":\"D:\\\\\",\"financial_management_system\":\"\",\"financial_management_system_version\":\"\",\"financial_management_system_version_detected\":\"\",\"financial_management_system_data_path\":\"\",\"spc_schedule_time\":\"2:00 AM\",\"spc_schedule_type\":\"Daily\",\"spc_schedule_interval\":\"6 Hours\",\"is_spc_update_locked\":\"False\",\"spc_update_lock_note\":\"\",\"last_spc_updated_checked\":\"\",\"is_delta_import_enable\":\"False\",\"etl_start\":\"2015-01-14 15:45:04\",\"etl_end\":\"2015-01-14 15:54:57\",\"web_upload_start\":\"2015-01-14 15:55:11\",\"web_upload_end\":\"2015-01-14 15:58:47\",\"local_upload_start\":\"2015-01-14 15:55:11\",\"local_upload_end\":\"2015-01-14 15:55:11\",\"financial_etl_start\":\"2015-01-14 14:00:06\",\"financial_etl_end\":\"2015-01-14 14:00:06\",\"etl_error_log\":\"\",\"etl_error_priority\":\"\",\"etl_error_description\":\"\",\"etl_cpu_utilization\":\"\",\"etl_memory_utilization\":\"\",\"financial_error_priority\":\"\",\"financial_error_description\":\"\",\"financial_etl_cpu_utilization\":\"\",\"financial_etl_memory_utilization\":\"\",\"local_insert_error_log\":\"\",\"local_insert_error_priority\":\"\",\"local_insert_cpu_utilization\":\"2.32361584878561\",\"local_insert_memory_utilization\":\"80269312\",\"local_upload_error_description\":\"\",\"web_upload_error_flag\":\"\",\"web_upload_error_priority\":\"\",\"web_upload_bandwidth_utilization\":\"492832\",\"web_upload_error_description\":\"\",\"upload_to_server\":\"2015-01-14 10:29:55\",\"upload_to_client\":\"2015-01-14 15:59:10\",\"domain\":\"Audiology\",\"spc_error_flag\":\"\",\"spc_error_priority\":\"\",\"spc_error_description\":\"\",\"timezone\":\"\",\"is_etl_edk\":\"\",\"etl_version\":\"\"}]}]\r\n"}],"_postman_id":"dd70ae05-2c54-47a9-ae0d-576bd443e99d"},{"name":"pms_environment","id":"34e50a55-a25a-4423-addb-e564532060c8","request":{"method":"GET","header":[],"url":"https://api.sikkasoft.com/auth/v2/pms_environment?app_id={app_id}&app_key={app_key}&value_type={value_type}&pms={pms}","description":"

This API provides different status values of appointments, patients , treatment_plan etc.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
app_id	This is the ID assigned to the application when the application is registered on API portal	Yes
app_key	This is the unique key generated when the application is registered on API portal	Yes
value_type	Type of value	No
pms	Name of practice management system	No

","urlObject":{"protocol":"https","path":["auth","v2","pms_environment"],"host":["api","sikkasoft","com"],"query":[{"key":"app_id","value":"{app_id}"},{"key":"app_key","value":"{app_key}"},{"key":"value_type","value":"{value_type}"},{"key":"pms","value":"{pms}"}],"variable":[]}},"response":[{"id":"d0c6dcc9-44f2-4dc8-a31a-5c6bdad2e632","name":"sample","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sikkasoft.com/auth/v2/sikka_practice_utility_details?app_id={app_id}&app_key={app_key}","protocol":"https","host":["api","sikkasoft","com"],"path":["auth","v2","sikka_practice_utility_details"],"query":[{"key":"app_id","value":"{app_id}"},{"key":"app_key","value":"{app_key}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Content-Encoding","key":"Content-Encoding","value":"gzip","description":""},{"name":"Content-Length","key":"Content-Length","value":"1236","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Sat, 22 Jul 2017 05:03:58 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"Vary","key":"Vary","value":"Accept-Encoding","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\r\n\t\"offset\": \"0\",\r\n\t\"limit\": \"2\",\r\n\t\"total_count\": \"29\",\r\n\t\"items\": [{\r\n\t\t\"pms\": \"Opendental\",\r\n\t\t\"value_type\": \"patient_status\",\r\n\t\t\"value\": \"0?\"\r\n\t}, {\r\n\t\t\"pms\": \"Opendental\",\r\n\t\t\"value_type\": \"patient_status\",\r\n\t\t\"value\": \"108?\"\r\n\t}]\r\n}]"}],"_postman_id":"34e50a55-a25a-4423-addb-e564532060c8"},{"name":"remove_access","id":"a26db7f2-ef6a-4f12-9f40-7cb050c20c6b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.sikkasoft.com/auth/v2/remove_access","description":"

This API will allow API partners to remove API access from practices (office_id).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
app_id	This is the ID assigned to the application when the application is registered on API portal	Yes
app_key	This is the unique key generated when the application is registered on API portal	Yes
office_id	office_id	Yes
comment	comment	Yes

","urlObject":{"protocol":"https","path":["auth","v2","remove_access"],"host":["api","sikkasoft","com"],"query":[],"variable":[]}},"response":[{"id":"221cf3c8-fe46-4b7e-8f97-c7d5c03fa369","name":"sample","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"app_id\": \"app_id\",\r\n\t\"app_key\": \"app_key\",\r\n\t\"practices\": [{\r\n\t\t\t\"office_id\": \"office_id1\",\r\n\t\t\t\"comment\": \"comment\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"office_id\": \"office_id2\",\r\n\t\t\t\"comment\": \"comment\"\r\n\t\t}\r\n\t]\r\n}"},"url":"https://api.sikkasoft.com/auth/v2/remove_access"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Content-Encoding","key":"Content-Encoding","value":"gzip","description":""},{"name":"Content-Length","key":"Content-Length","value":"1236","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Sat, 22 Jul 2017 05:03:58 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"Vary","key":"Vary","value":"Accept-Encoding","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"practices\": [{\r\n\t\t\"office_id\": \"office_id1\",\r\n\t\t\"comment\": \"DevTesting\",\r\n\t\t\"status\": \"access removed\"\r\n\t}, {\r\n\t\t\"office_id\": \"office_id2\",\r\n\t\t\"comment\": \"DevTesting\",\r\n\t\t\"status\": \"access removed\"\r\n\t}]\r\n}"}],"_postman_id":"a26db7f2-ef6a-4f12-9f40-7cb050c20c6b"}],"id":"2f8d83b4-3cd9-478c-9ffb-f6ab3a7811ae","description":"

Sikka authentication API contains all API related with Sikka authentication. Like account log in ,singup , update abd delete.\nAlso about request key information , application details , authentication etc.

\n","_postman_id":"2f8d83b4-3cd9-478c-9ffb-f6ab3a7811ae"},{"name":"Finance","item":[{"name":"finance/accounts","id":"5d240a59-470a-4d2f-86d1-64081b8c78fc","request":{"method":"GET","header":[],"url":"{{url}}/finance/accounts?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
account_name	Account Name	No
account_number	Account Number	No
account_type	Account type	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
account_number	Account Number

","urlObject":{"path":["finance","accounts"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"b27b9a1b-3c53-4d85-93dd-c7ab67e50c9d","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/accounts?request_key={{request_key}}","host":["{{url}}"],"path":["finance","accounts"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"721","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 09:12:59 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"154\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/accounts\\/9550\",\"account_number\":\"9550\",\"account_name\":\"9550 . Non deductible expenses\",\"account_fullname\":\"Non deductible expenses\",\"description\":\"\",\"account_type\":\"OtherExpense\",\"balance_total\":\"420.0600\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/accounts\\/90000\",\"account_number\":\"90000\",\"account_name\":\"90000 . Estimates\",\"account_fullname\":\"Estimates\",\"description\":\"\",\"account_type\":\"NonPosting\",\"balance_total\":\"0.0000\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"5d240a59-470a-4d2f-86d1-64081b8c78fc"},{"name":"finance/accounts by account_number","id":"02e81ddc-53fb-4ed6-abdc-727e1ec8ce79","request":{"method":"GET","header":[],"url":"{{url}}/finance/accounts/{account_number}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
account_name	Account Name	No
account_number	Account Number	No
account_type	Account type	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
account_number	Account Number

","urlObject":{"path":["finance","accounts","{account_number}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"70f740b3-f4fa-49c2-a742-10ed6dc80dc0","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/accounts/{account_number}?request_key={{request_key}}","host":["{{url}}"],"path":["finance","accounts","{account_number}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"346","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 09:15:36 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/accounts\\/9550\",\"account_number\":\"9550\",\"account_name\":\"9550 . Non deductible expenses\",\"account_fullname\":\"Non deductible expenses\",\"description\":\"\",\"account_type\":\"OtherExpense\",\"balance_total\":\"420.0600\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"02e81ddc-53fb-4ed6-abdc-727e1ec8ce79"},{"name":"finance/balances","id":"49b86604-d8d8-40ee-adb5-eb6616076ccc","request":{"method":"GET","header":[],"url":"{{url}}/finance/balances?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
account_name	Account Name

","urlObject":{"path":["finance","balances"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"773e5dad-2d48-4d6e-8dc7-2c45ff4e6e4c","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/balances?request_key={{request_key}}","host":["{{url}}"],"path":["finance","balances"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"576","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 09:19:31 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"631\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/balances\\/Total Other Current Liabilities\",\"account_name\":\"Total Other Current Liabilities\",\"balance_total\":\"2767.3400\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/balances\\/Total Other Current Liabilities\",\"account_name\":\"Total Other Current Liabilities\",\"balance_total\":\"1918.7500\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"49b86604-d8d8-40ee-adb5-eb6616076ccc"},{"name":"finance/balances by account_name","id":"0e9d973b-c2f4-47be-a9c8-e25f28e59b94","request":{"method":"GET","header":[],"url":"{{url}}/finance/balances/{account_name}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
account_name	Account Name

","urlObject":{"path":["finance","balances","{account_name}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"ad7460ce-5a27-4ffa-b2cb-cf899bafbf50","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/balances/{account_name}?request_key={{request_key}}","host":["{{url}}"],"path":["finance","balances","{account_name}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"259","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 09:22:29 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/balances\\/Total Other Current Liabilities\",\"account_name\":\"Total Other Current Liabilities\",\"balance_total\":\"1918.7500\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"0e9d973b-c2f4-47be-a9c8-e25f28e59b94"},{"name":"finance/budgets","id":"cfcfd5c2-10aa-440f-b834-8437b089537b","request":{"method":"GET","header":[],"url":"{{url}}/finance/budgets?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
account_name	Account Name

","urlObject":{"path":["finance","budgets"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"1ca50b00-3475-487b-81c6-add856c6b9cb","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/budgets?request_key={{request_key}}&limit=2","host":["{{url}}"],"path":["finance","budgets"],"query":[{"key":"request_key","value":"{{request_key}}"},{"key":"limit","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"898","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 09:25:30 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"158\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/budgets\\/Water\",\"account_name\":\"Water\",\"january\":\"0.0000\",\"february\":\"0.0000\",\"march\":\"0.0000\",\"april\":\"0.0000\",\"may\":\"0.0000\",\"june\":\"0.0000\",\"july\":\"0.0000\",\"august\":\"0.0000\",\"september\":\"0.0000\",\"october\":\"0.0000\",\"november\":\"0.0000\",\"december\":\"0.0000\",\"total\":\"0.0000\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/budgets\\/Voided Check\",\"account_name\":\"Voided Check\",\"january\":\"0.0000\",\"february\":\"0.0000\",\"march\":\"0.0000\",\"april\":\"0.0000\",\"may\":\"0.0000\",\"june\":\"0.0000\",\"july\":\"0.0000\",\"august\":\"0.0000\",\"september\":\"0.0000\",\"october\":\"0.0000\",\"november\":\"0.0000\",\"december\":\"0.0000\",\"total\":\"0.0000\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"cfcfd5c2-10aa-440f-b834-8437b089537b"},{"name":"finance/budgets by account_name","id":"4f5a690c-7ba2-47be-b5aa-5574195cda49","request":{"method":"GET","header":[],"url":"{{url}}/finance/budgets/{account_name}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
account_name	Account Name

","urlObject":{"path":["finance","budgets","{account_name}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"67fa7dac-161b-4a88-b090-5481bf71324a","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/budgets/{account_name}?request_key={{request_key}}","host":["{{url}}"],"path":["finance","budgets","{account_name}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"413","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 09:28:11 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/budgets\\/Water\",\"account_name\":\"Water\",\"january\":\"0.0000\",\"february\":\"0.0000\",\"march\":\"0.0000\",\"april\":\"0.0000\",\"may\":\"0.0000\",\"june\":\"0.0000\",\"july\":\"0.0000\",\"august\":\"0.0000\",\"september\":\"0.0000\",\"october\":\"0.0000\",\"november\":\"0.0000\",\"december\":\"0.0000\",\"total\":\"0.0000\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"4f5a690c-7ba2-47be-b5aa-5574195cda49"},{"name":"finance/customers","id":"f125d190-3cec-4668-b18b-f81e45f35294","request":{"method":"GET","header":[],"url":"{{url}}/finance/customers?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
customer_id	Customer Id	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
customer_id	Customer Id

","urlObject":{"path":["finance","customers"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"49e6bb5a-3789-412d-a4bd-2ac239ecb77d","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/customers?request_key={{request_key}}","host":["{{url}}"],"path":["finance","customers"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"3178","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 09:31:33 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"197\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/customers\\/0\",\"account_number\":\"\",\"alt_contact\":\"\",\"alt_phone\":\"\",\"balance\":\"0\",\"billaddress_addr1\":\"Agatha Bolls\",\"billaddress_addr2\":\"\",\"billaddress_addr3\":\"\",\"billaddress_addr4\":\"\",\"billaddress_city\":\"\",\"billaddress_country\":\"\",\"billaddress_postalcode\":\"\",\"billaddress_state\":\"\",\"company_name\":\"\",\"contact\":\"\",\"creditcardinfo_creditcardaddress\":\"\",\"creditcardinfo_creditcardnumber\":\"\",\"creditcardinfo_creditcardpostalcode\":\"\",\"creditcardinfo_expirationmonth\":\"0\",\"creditcardinfo_expirationyear\":\"0\",\"creditcardinfo_nameoncard\":\"\",\"credit_limit\":\"0\",\"customer_id\":\"0\",\"customertyperef_fullname\":\"\",\"customertyperef_listid\":\"\",\"edit_sequence\":\"1075158587\",\"email\":\"\",\"error_message\":\"\",\"fax\":\"\",\"firstname\":\"\",\"fullname\":\"Agatha Bolls\",\"is_active\":\"True\",\"itemsalestaxref_fullname\":\"\",\"itemsalestaxref_listid\":\"\",\"lastname\":\"\",\"list_id\":\"Agatha Bolls\",\"name\":\"Agatha Bolls\",\"notes\":\"\",\"parentref_fullname\":\"\",\"parentref_listid\":\"\",\"phone\":\"\",\"preferredpaymentmethodref_fullname\":\"\",\"preferredpaymentmethodref_listid\":\"\",\"salesrepref_fullname\":\"\",\"salesrepref_listid\":\"\",\"salestaxcoderef_fullname\":\"Non\",\"salestaxcoderef_listid\":\"20000-1043788278\",\"salutation\":\"\",\"shipaddress_addr1\":\"\",\"shipaddress_addr2\":\"\",\"shipaddress_addr3\":\"\",\"shipaddress_addr4\":\"\",\"shipaddress_city\":\"\",\"shipaddress_country\":\"\",\"shipaddress_postalcode\":\"\",\"shipaddress_state\":\"\",\"sublevel\":\"0\",\"termsref_fullname\":\"\",\"trmsref_listid\":\"\",\"time_created\":\"2004-01-26 00:00:00\",\"time_modified\":\"2004-01-26 00:00:00\",\"total_balance\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/customers\\/0\",\"account_number\":\"\",\"alt_contact\":\"\",\"alt_phone\":\"\",\"balance\":\"0\",\"billaddress_addr1\":\"Allen Hansen\",\"billaddress_addr2\":\"\",\"billaddress_addr3\":\"\",\"billaddress_addr4\":\"\",\"billaddress_city\":\"\",\"billaddress_country\":\"\",\"billaddress_postalcode\":\"\",\"billaddress_state\":\"\",\"company_name\":\"\",\"contact\":\"\",\"creditcardinfo_creditcardaddress\":\"\",\"creditcardinfo_creditcardnumber\":\"\",\"creditcardinfo_creditcardpostalcode\":\"\",\"creditcardinfo_expirationmonth\":\"0\",\"creditcardinfo_expirationyear\":\"0\",\"creditcardinfo_nameoncard\":\"\",\"credit_limit\":\"0\",\"customer_id\":\"0\",\"customertyperef_fullname\":\"\",\"customertyperef_listid\":\"\",\"edit_sequence\":\"1168211769\",\"email\":\"\",\"error_message\":\"\",\"fax\":\"\",\"firstname\":\"\",\"fullname\":\"Allen Hansen\",\"is_active\":\"True\",\"itemsalestaxref_fullname\":\"\",\"itemsalestaxref_listid\":\"\",\"lastname\":\"\",\"list_id\":\"Allen Hansen\",\"name\":\"Allen Hansen\",\"notes\":\"\",\"parentref_fullname\":\"\",\"parentref_listid\":\"\",\"phone\":\"\",\"preferredpaymentmethodref_fullname\":\"\",\"preferredpaymentmethodref_listid\":\"\",\"salesrepref_fullname\":\"\",\"salesrepref_listid\":\"\",\"salestaxcoderef_fullname\":\"Non\",\"salestaxcoderef_listid\":\"20000-1043788278\",\"salutation\":\"\",\"shipaddress_addr1\":\"\",\"shipaddress_addr2\":\"\",\"shipaddress_addr3\":\"\",\"shipaddress_addr4\":\"\",\"shipaddress_city\":\"\",\"shipaddress_country\":\"\",\"shipaddress_postalcode\":\"\",\"shipaddress_state\":\"\",\"sublevel\":\"0\",\"termsref_fullname\":\"\",\"trmsref_listid\":\"\",\"time_created\":\"2007-01-07 00:00:00\",\"time_modified\":\"2007-01-07 00:00:00\",\"total_balance\":\"0\"}]}]\r\n"}],"_postman_id":"f125d190-3cec-4668-b18b-f81e45f35294"},{"name":"finance/customers by customer_id","id":"2268e18f-7f81-4705-bb09-cacdb1288e6a","request":{"method":"GET","header":[],"url":"{{url}}/finance/customers/{customer_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
customer_id	Customer Id	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
customer_id	Customer Id

","urlObject":{"path":["finance","customers","{customer_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"3e931039-498c-44a4-8a62-df37cfd4ae8d","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/customers/{customer_id}?request_key={{request_key}}","host":["{{url}}"],"path":["finance","customers","{customer_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1560","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 09:48:58 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/customers\\/0\",\"account_number\":\"\",\"alt_contact\":\"\",\"alt_phone\":\"\",\"balance\":\"0\",\"billaddress_addr1\":\"Agatha Bolls\",\"billaddress_addr2\":\"\",\"billaddress_addr3\":\"\",\"billaddress_addr4\":\"\",\"billaddress_city\":\"\",\"billaddress_country\":\"\",\"billaddress_postalcode\":\"\",\"billaddress_state\":\"\",\"company_name\":\"\",\"contact\":\"\",\"creditcardinfo_creditcardaddress\":\"\",\"creditcardinfo_creditcardnumber\":\"\",\"creditcardinfo_creditcardpostalcode\":\"\",\"creditcardinfo_expirationmonth\":\"0\",\"creditcardinfo_expirationyear\":\"0\",\"creditcardinfo_nameoncard\":\"\",\"credit_limit\":\"0\",\"customer_id\":\"0\",\"customertyperef_fullname\":\"\",\"customertyperef_listid\":\"\",\"edit_sequence\":\"1075158587\",\"email\":\"\",\"error_message\":\"\",\"fax\":\"\",\"firstname\":\"\",\"fullname\":\"Agatha Bolls\",\"is_active\":\"True\",\"itemsalestaxref_fullname\":\"\",\"itemsalestaxref_listid\":\"\",\"lastname\":\"\",\"list_id\":\"Agatha Bolls\",\"name\":\"Agatha Bolls\",\"notes\":\"\",\"parentref_fullname\":\"\",\"parentref_listid\":\"\",\"phone\":\"\",\"preferredpaymentmethodref_fullname\":\"\",\"preferredpaymentmethodref_listid\":\"\",\"salesrepref_fullname\":\"\",\"salesrepref_listid\":\"\",\"salestaxcoderef_fullname\":\"Non\",\"salestaxcoderef_listid\":\"20000-1043788278\",\"salutation\":\"\",\"shipaddress_addr1\":\"\",\"shipaddress_addr2\":\"\",\"shipaddress_addr3\":\"\",\"shipaddress_addr4\":\"\",\"shipaddress_city\":\"\",\"shipaddress_country\":\"\",\"shipaddress_postalcode\":\"\",\"shipaddress_state\":\"\",\"sublevel\":\"0\",\"termsref_fullname\":\"\",\"trmsref_listid\":\"\",\"time_created\":\"2004-01-26 00:00:00\",\"time_modified\":\"2004-01-26 00:00:00\",\"total_balance\":\"0\"}\r\n"}],"_postman_id":"2268e18f-7f81-4705-bb09-cacdb1288e6a"},{"name":"finance/employee","id":"79825612-b322-4275-a7b0-f3dd12d8785a","request":{"method":"GET","header":[],"url":"{{url}}/finance/employee?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
employee	employee name	No
account_number	Account Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
account_number	Account Number

","urlObject":{"path":["finance","employee"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"b0cfc458-4bc3-4add-9dec-338e10ec6cab","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/employee?request_key={{request_key}}","host":["{{url}}"],"path":["finance","employee"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"559","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 09:51:24 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"33\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/employee\\/KM2010\",\"employee\":\"K M Waldrop\",\"type\":\"Regular\",\"phone\":\"\",\"address1\":\"\",\"account_number\":\"KM2010\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/employee\\/81709\",\"employee\":\"Krista L Echoff\",\"type\":\"Regular\",\"phone\":\"\",\"address1\":\"\",\"account_number\":\"81709\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"79825612-b322-4275-a7b0-f3dd12d8785a"},{"name":"finance/employee by account_number","id":"c24611bb-e45d-4d83-80d3-9655b4f2f1cc","request":{"method":"GET","header":[],"url":"{{url}}/finance/employee/{account_number}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
employee	employee name	No
account_number	Account Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
account_number	Account Number

","urlObject":{"path":["finance","employee","{account_number}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"80769016-81eb-407d-a30f-1a2c88ee944d","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/employee/{account_number}?request_key={{request_key}}","host":["{{url}}"],"path":["finance","employee","{account_number}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"250","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:01:09 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/employee\\/KM2010\",\"employee\":\"K M Waldrop\",\"type\":\"Regular\",\"phone\":\"\",\"address1\":\"\",\"account_number\":\"KM2010\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"c24611bb-e45d-4d83-80d3-9655b4f2f1cc"},{"name":"finance/payroll_details","id":"7a786211-cb18-40f0-b7a5-4abcc693f1ca","request":{"method":"GET","header":[],"url":"{{url}}/finance/payroll_details?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
ref_number	Ref Number

","urlObject":{"path":["finance","payroll_details"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"29fd92b3-6434-40c5-9419-7d27a2915fd0","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/payroll_details?request_key={{request_key}}","host":["{{url}}"],"path":["finance","payroll_details"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"813","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:05:02 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"1307\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/payroll_details\\/9999\",\"txn_type\":\"Paycheck\",\"date\":\"2015-06-16\",\"ref_number\":\"9999\",\"source_name\":\"Lisa A Friederich\",\"payroll_item\":\"Hourly Rate\",\"class\":\"\",\"amount\":\"1653.7500\",\"wagebase\":\"0.0000\",\"debit\":\"1653.7500\",\"credit\":\"0.0000\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/payroll_details\\/9999\",\"txn_type\":\"Paycheck\",\"date\":\"2015-06-16\",\"ref_number\":\"9999\",\"source_name\":\"Lisa A Friederich\",\"payroll_item\":\"monthly bonus\",\"class\":\"\",\"amount\":\"341.1600\",\"wagebase\":\"0.0000\",\"debit\":\"341.1600\",\"credit\":\"0.0000\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"7a786211-cb18-40f0-b7a5-4abcc693f1ca"},{"name":"finance/payroll_details by ref_number","id":"2836779b-980d-4edd-bb5b-b7c00c16b5e3","request":{"method":"GET","header":[],"url":"{{url}}/finance/payroll_details/{ref_number}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
ref_number	Ref Number

","urlObject":{"path":["finance","payroll_details","{ref_number}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"ce1d5aa4-f3db-49c9-80f2-344825727102","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/payroll_details/{ref_number}?request_key={{request_key}}","host":["{{url}}"],"path":["finance","payroll_details","{ref_number}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"377","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:07:23 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/finance\\/payroll_details\\/9999\",\"txn_type\":\"Paycheck\",\"date\":\"2015-06-16\",\"ref_number\":\"9999\",\"source_name\":\"Lisa A Friederich\",\"payroll_item\":\"Hourly Rate\",\"class\":\"\",\"amount\":\"1653.7500\",\"wagebase\":\"0.0000\",\"debit\":\"1653.7500\",\"credit\":\"0.0000\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"2836779b-980d-4edd-bb5b-b7c00c16b5e3"},{"name":"finance/transactions","id":"26957a1f-259f-45df-a2aa-0409f0dcc4a0","request":{"method":"GET","header":[],"url":"{{url}}/finance/transactions?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
account_name	Account Name

","urlObject":{"path":["finance","transactions"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"1c240c16-8c2b-423a-bd61-cb17798e7a57","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/transactions?request_key={{request_key}}","host":["{{url}}"],"path":["finance","transactions"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1738","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:10:30 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"3806\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/finance/transactions/Water\",\n \"txn_type\": \"Check\",\n \"date\": \"2015-06-08\",\n \"ref_number\": \"9981\",\n \"name\": \"Test Company\",\n \"memo\": \"10-210003607740\",\n \"account_name\": \"Water\",\n \"account_number\": \"\",\n \"class\": \"\",\n \"cleared_status\": \"NotCleared\",\n \"split_account\": \"1045 . Cash in Bank - PNC Bank\",\n \"debit\": \"142.0400\",\n \"credit\": \"0.0000\",\n \"amount\": \"142.0400\",\n \"running_balance\": \"413.0800\",\n \"due_date\": \"\",\n \"paid_status\": \"Unpaid\",\n \"name_account_number\": \"Test Company\",\n \"name_address\": \"\",\n \"name_city\": \"\",\n \"name_contact\": \"\",\n \"name_email\": \"\",\n \"name_fax\": \"\",\n \"name_state\": \"\",\n \"name_zip\": \"\",\n \"open_balance\": \"142.0400\",\n \"original_amount\": \"142.0400\",\n \"progress_amount\": \"0.0000\",\n \"name_address2\": \"\",\n \"name_secondary_phone\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/finance/transactions/Water\",\n \"txn_type\": \"Check\",\n \"date\": \"2015-08-02\",\n \"ref_number\": \"10077\",\n \"name\": \"Test Company\",\n \"memo\": \"Check 10 095554157\",\n \"account_name\": \"Water\",\n \"account_number\": \"\",\n \"class\": \"\",\n \"cleared_status\": \"NotCleared\",\n \"split_account\": \"10. Cash in Bank - PNC Bank\",\n \"debit\": \"153.1800\",\n \"credit\": \"0.0000\",\n \"amount\": \"153.1800\",\n \"running_balance\": \"805.5100\",\n \"due_date\": \"\",\n \"paid_status\": \"Unpaid\",\n \"name_account_number\": \"Test Company\",\n \"name_address\": \"\",\n \"name_city\": \"\",\n \"name_contact\": \"\",\n \"name_email\": \"\",\n \"name_fax\": \"\",\n \"name_state\": \"\",\n \"name_zip\": \"\",\n \"open_balance\": \"153.1800\",\n \"original_amount\": \"153.1800\",\n \"progress_amount\": \"0.0000\",\n \"name_address2\": \"\",\n \"name_secondary_phone\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n }\n ]\n }\n]"}],"_postman_id":"26957a1f-259f-45df-a2aa-0409f0dcc4a0"},{"name":"finance/transactions by account_name","id":"0299d772-0501-4870-ba11-8481e254a877","request":{"method":"GET","header":[],"url":"{{url}}/finance/transactions/{account_name}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
account_name	Account Name

","urlObject":{"path":["finance","transactions","{account_name}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"16382f66-4dbc-4ceb-809d-cbdad372140a","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/transactions/{account_name}?request_key={{request_key}}","host":["{{url}}"],"path":["finance","transactions","{account_name}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"840","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:13:11 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"href\": \"https://api.sikkasoft.com/v2/finance/transactions/Water\",\n \"txn_type\": \"Check\",\n \"date\": \"2015-05-10\",\n \"ref_number\": \"9952\",\n \"name\": \"Test Company\",\n \"memo\": \"Check 9952 090380278\",\n \"account_name\": \"Water\",\n \"account_number\": \"\",\n \"class\": \"\",\n \"cleared_status\": \"NotCleared\",\n \"split_account\": \"1045 . Cash in Bank - PNC Bank\",\n \"debit\": \"102.8500\",\n \"credit\": \"0.0000\",\n \"amount\": \"102.8500\",\n \"running_balance\": \"102.8500\",\n \"due_date\": \"\",\n \"paid_status\": \"Unpaid\",\n \"name_account_number\": \"TestCompany\",\n \"name_address\": \"\",\n \"name_city\": \"\",\n \"name_contact\": \"\",\n \"name_email\": \"\",\n \"name_fax\": \"\",\n \"name_state\": \"\",\n \"name_zip\": \"\",\n \"open_balance\": \"102.8500\",\n \"original_amount\": \"102.8500\",\n \"progress_amount\": \"0.0000\",\n \"name_address2\": \"\",\n \"name_secondary_phone\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n}"}],"_postman_id":"0299d772-0501-4870-ba11-8481e254a877"},{"name":"finance/vendors","id":"80ce020a-5ca9-4744-adff-ed0bf5207df9","request":{"method":"GET","header":[],"url":"{{url}}/finance/vendors?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
vendor	valid vendor, coma separated for multiple	No
account_number	Account Number	No
contact_person	Contact Person	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
account_number	Account Number

","urlObject":{"path":["finance","vendors"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"23fdee45-cd88-45c7-b6a7-11499115c87a","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/vendors?request_key={{request_key}}","host":["{{url}}"],"path":["finance","vendors"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"695","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:15:01 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"531\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/finance/vendors/Orascoptic Research\",\n \"vendor\": \"Test Vendor\",\n \"account_number\": \"MATB00\",\n \"address\": \"\",\n \"contact_person\": \"\",\n \"phone\": \"xxxxxxxxxx\",\n \"fax\": \"xxxxxxxxxx\",\n \"balance_total\": \"0\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/finance/vendors/IMG Care\",\n \"vendor\": \"Test Vendor\",\n \"account_number\": \"ID30966\",\n \"address\": \"\",\n \"contact_person\": \"\",\n \"phone\": \"xxxxxxxxxx\",\n \"fax\": \"xxxxxxxxxx\",\n \"balance_total\": \"0\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n }\n ]\n }\n]"}],"_postman_id":"80ce020a-5ca9-4744-adff-ed0bf5207df9"},{"name":"finance/vendors by vendor","id":"072905f4-069c-4339-8578-7de1a6e5929f","request":{"method":"GET","header":[],"url":"{{url}}/finance/vendors/{vendor}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
vendor	valid vendor, coma separated for multiple	No
account_number	Account Number	No
contact_person	Contact Person	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
account_number	Account Number

","urlObject":{"path":["finance","vendors","{vendor}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"05e3b7e1-fa99-4143-a080-35ba376940f0","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/finance/vendors/{vendor}?request_key={{request_key}}","host":["{{url}}"],"path":["finance","vendors","{vendor}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"328","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:18:15 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"href\": \"https://api.sikkasoft.com/v2/finance/vendors/Orascoptic Research\",\n \"vendor\": \"Test Vendor\",\n \"account_number\": \"MAB001\",\n \"address\": \"\",\n \"contact_person\": \"\",\n \"phone\": \"xxxxxxxxxx\",\n \"fax\": \"xxxxxxxxxx\",\n \"balance_total\": \"0\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n}"}],"_postman_id":"072905f4-069c-4339-8578-7de1a6e5929f"}],"id":"83171a6b-af9e-4264-96a2-470fb9fdf98b","description":"

Sikka APIs allows you to get the data extracted from financial systems like Quickbooks. Explore finance API for more details

\n","_postman_id":"83171a6b-af9e-4264-96a2-470fb9fdf98b"},{"name":"Practices","item":[{"name":"practices","id":"e1c9a73a-8a3c-46cd-b41c-a7e0e550e57a","request":{"method":"GET","header":[],"url":"{{url}}/practices?request_key={{request_key}}","description":"

\"Practices\" API will return the collection of all practices

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
name	Practice Name

","urlObject":{"path":["practices"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"f2c1d46c-9753-435d-b226-aa1892d396c5","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/practices?request_key={{request_key}}","host":["{{url}}"],"path":["practices"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1471","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:21:18 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"500\",\n \"total_count\": \"2\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/2\",\n \"practice_id\": \"2\",\n \"name\": \"Demo Sikka Practice -2\",\n \"address_line1\": \"San jose\",\n \"address_line2\": \"San Jose\",\n \"city\": \"San Jose\",\n \"state\": \"CA\",\n \"zipcode\": \"95011\",\n \"phone\": \"xxxxxxxxxx\",\n \"country\": \"\",\n \"email\": \"\",\n \"website\": \"\",\n \"description\": \"\",\n \"providers\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/2/providers/\"\n },\n \"patients\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/2/patients/\"\n },\n \"guarantors\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/2/guarantors/\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/2/appointments/\"\n },\n \"transactions\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/2/transactions/\"\n }\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\",\n \"practice_id\": \"1\",\n \"name\": \"Demo Sikka Practice\",\n \"address_line1\": \"San Jose\",\n \"address_line2\": \"San Jose\",\n \"city\": \"San Jose\",\n \"state\": \"CA\",\n \"zipcode\": \"95011\",\n \"phone\": \"xxxxxxxxxx\",\n \"country\": \"\",\n \"email\": \"\",\n \"website\": \"\",\n \"description\": \"\",\n \"providers\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/\"\n },\n \"patients\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/\"\n },\n \"guarantors\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments/\"\n },\n \"transactions\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/transactions/\"\n }\n }\n ]\n }\n]"}],"_postman_id":"e1c9a73a-8a3c-46cd-b41c-a7e0e550e57a"},{"name":"practices by practice_id","id":"a075bda9-1bd8-4554-b1ad-7530f796051e","request":{"method":"GET","header":[],"url":"{{url}}/practices/{practice_id}?request_key={{request_key}}","description":"

Get the information of practice as per the practice id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
name	Practice Name

","urlObject":{"path":["practices","{practice_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"b44d2bb9-1c1a-4e60-a67f-2911b48236de","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/practices/{practice_id}?request_key={{request_key}}","host":["{{url}}"],"path":["practices","{practice_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"708","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:23:07 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"href\": \"https://api.sikkasoft.com/v2/practices/2\",\n \"practice_id\": \"2\",\n \"name\": \"Demo Sikka Practice -2\",\n \"address_line1\": \"San jose\",\n \"address_line2\": \"San Jose\",\n \"city\": \"San Jose\",\n \"state\": \"CA\",\n \"zipcode\": \"95011\",\n \"phone\": \"xxxxxxxxxx\",\n \"country\": \"\",\n \"email\": \"\",\n \"website\": \"\",\n \"description\": \"\",\n \"providers\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/2/providers/\"\n },\n \"patients\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/2/patients/\"\n },\n \"guarantors\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/2/guarantors/\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/2/appointments/\"\n },\n \"transactions\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/2/transactions/\"\n }\n}"}],"_postman_id":"a075bda9-1bd8-4554-b1ad-7530f796051e"},{"name":"veterinary_clinics","id":"ebe09fd1-4b93-49b1-9d72-1719b410504c","request":{"method":"GET","header":[],"url":"{{url}}/veterinary_clinics?request_key={{request_key}}","description":"

Veterinary clinics API returns information about clinics as per shelter practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
veterinary_clinic_id	Veterinary clinic id
name	Veterinary clinic name

","urlObject":{"path":["veterinary_clinics"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"bfc0db8f-1bac-4ba0-85c6-4cce742a645d","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/veterinary_clinics?request_key={{request_key}}","host":["{{url}}"],"path":["veterinary_clinics"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"645","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 09:19:02 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"3\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/veterinary_clinics/3\",\n \"veterinary_clinic_id\": \"3\",\n \"name\": \"TestVet_003\",\n \"address_line1\": \"AKOTA\",\n \"address_line2\": \"O.P.Road\",\n \"city\": \"VADO\",\n \"state\": \"Rajkot\",\n \"zipcode\": \"390017\",\n \"phone\": \"xxxxxxxxxx\",\n \"email\": \"test@demo1.com\",\n \"description\": \"Demo_vet002\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/veterinary_clinics/2\",\n \"veterinary_clinic_id\": \"2\",\n \"name\": \"BTestVet_002\",\n \"address_line1\": \"Manjalpur\",\n \"address_line2\": \"Aksharchowk\",\n \"city\": \"Vadodara\",\n \"state\": \"GUJ\",\n \"zipcode\": \"390001\",\n \"phone\": \"xxxxxxxxxx\",\n \"email\": \"test@demo1.com\",\n \"description\": \"Demo_vet001\"\n }\n ]\n }\n]"}],"_postman_id":"ebe09fd1-4b93-49b1-9d72-1719b410504c"},{"name":"veterinary_clinics by veterinary_clinic_id","id":"aec6a259-b880-475e-95e8-d94930672adc","request":{"method":"GET","header":[],"url":"{{url}}/veterinary_clinics/{veterinary_clinic_id}?request_key={{request_key}}","description":"

Veterinary clinics API returns information about pet as per shelter practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
veterinary_clinic_id	Veterinary clinic id
name	Veterinary clinic name

","urlObject":{"path":["veterinary_clinics","{veterinary_clinic_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"b7a8efdf-83db-4055-a87d-a56a3617db9a","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/veterinary_clinics/{veterinary_clinic_id}?request_key={{request_key}}","host":["{{url}}"],"path":["veterinary_clinics","{veterinary_clinic_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"349","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 09:21:03 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"500\",\"total_count\":\"1\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/veterinary_clinics\\/3\",\"veterinary_clinic_id\":\"3\",\"name\":\"TestVet_003\",\"address_line1\":\"AKOTA\",\"address_line2\":\"O.P.Road\",\"city\":\"VADO\",\"state\":\"Rajkot\",\"zipcode\":\"390017\",\"phone\":\"4563217890\",\"email\":\"107.20.157.107\",\"description\":\"Demo_vet002\"}]}]\r\n"}],"_postman_id":"aec6a259-b880-475e-95e8-d94930672adc"},{"name":"accounts_receivables","id":"4e0b1ca1-60f7-4d66-b0fc-db5f9a282c11","request":{"method":"GET","header":[],"url":"{{url}}/accounts_receivables?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
guarantor_id	Guarantor id as per practice management systems	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
guarantor_id	Guarantor id as per practice management systems
practice_id	Practice ID
amount_less_than_30	Amount Less Than 30
amount_between_30_60	Amount Between 30 And 60
amount_between_60_90	Amount Between 60 And 90
amount_greater_than_90	Amount Greater Than 90
current_date	Current Date
entry_id	Entry ID

","urlObject":{"path":["accounts_receivables"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"2e46ed7f-e4c3-4fd7-813c-adf319db5541","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/accounts_receivables?request_key={{request_key}}","host":["{{url}}"],"path":["accounts_receivables"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"941","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 09:35:49 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"9119\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/accounts_receivables\\/6066\",\"guarantor_id\":\"6066\",\"amount_less_than_30\":\"127\",\"amount_between_30_60\":\"0\",\"amount_between_60_90\":\"0\",\"amount_greater_than_90\":\"0\",\"practice_id\":\"1\",\"entry_id\":\"1706324\",\"current_date\":\"2016-05-10\",\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/6066\"},\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/accounts_receivables\\/6063\",\"guarantor_id\":\"6063\",\"amount_less_than_30\":\"335\",\"amount_between_30_60\":\"0\",\"amount_between_60_90\":\"0\",\"amount_greater_than_90\":\"0\",\"practice_id\":\"1\",\"entry_id\":\"1706323\",\"current_date\":\"2016-05-10\",\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/6063\"},\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"4e0b1ca1-60f7-4d66-b0fc-db5f9a282c11"},{"name":"accounts_receivables by guarantor_id","id":"e7fa1a97-32ea-449e-999e-70da28422274","request":{"method":"GET","header":[],"url":"{{url}}/accounts_receivables/{guarantor_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
guarantor_id	Guarantor id as per practice management systems	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
guarantor_id	Guarantor id as per practice management systems
practice_id	Practice ID
amount_less_than_30	Amount Less Than 30
amount_between_30_60	Amount Between 30 And 60
amount_between_60_90	Amount Between 60 And 90
amount_greater_than_90	Amount Greater Than 90
current_date	Current Date
entry_id	Entry ID

","urlObject":{"path":["accounts_receivables","{guarantor_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"3875cddf-96cd-4e9c-9dd6-f1461ad10297","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/accounts_receivables/{{guarantor_id}}?request_key={{request_key}}","host":["{{url}}"],"path":["accounts_receivables","{{guarantor_id}}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"441","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 09:56:31 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/accounts_receivables\\/6066\",\"guarantor_id\":\"6066\",\"amount_less_than_30\":\"127\",\"amount_between_30_60\":\"0\",\"amount_between_60_90\":\"0\",\"amount_greater_than_90\":\"0\",\"practice_id\":\"1\",\"entry_id\":\"1706324\",\"current_date\":\"2016-05-10\",\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/6066\"},\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"e7fa1a97-32ea-449e-999e-70da28422274"},{"name":"clinical_conditions","id":"a138b45e-6590-472a-8edb-d83433c35c73","request":{"method":"GET","header":[],"url":"{{url}}/clinical_conditions?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
status	appointment / treatment plan / clinical_conditions status	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
status	appointment / treatment plan / clinical_conditions status
id	valid id, coma separated for multiple
description	Description
condition_name	Condition Name
tooth_surface	Tooth Surface

","urlObject":{"path":["clinical_conditions"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"c2b62972-99b3-49a5-b3c6-01849c7f24d4","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/clinical_conditions?request_key={{request_key}}","host":["{{url}}"],"path":["clinical_conditions"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"648","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 11:03:33 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"139\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/clinical_conditions\\/544501615\",\"id\":\"544501615\",\"condition_name\":\"32\",\"tooth_surface\":\"Tooth & Surface Required\",\"description\":\"108\",\"status\":\"Active\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/clinical_conditions\\/538999148\",\"id\":\"538999148\",\"condition_name\":\"7\",\"tooth_surface\":\"Tooth & Surface Required\",\"description\":\"32\",\"status\":\"Active\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"a138b45e-6590-472a-8edb-d83433c35c73"},{"name":"clinical_conditions by id","id":"31046554-e5ff-4268-b8a9-0eca295850d6","request":{"method":"GET","header":[],"url":"{{url}}/clinical_conditions/{id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
status	appointment / treatment plan / clinical_conditions status	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
status	appointment / treatment plan / clinical_conditions status
id	valid id, coma separated for multiple
description	Description
condition_name	Condition Name
tooth_surface	Tooth Surface

","urlObject":{"path":["clinical_conditions","{id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"dd1c197c-f5bc-46cd-8745-6e2954651d51","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/clinical_conditions/{{id}}}?request_key={{request_key}}","host":["{{url}}"],"path":["clinical_conditions","{{id}}}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"355","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 11:07:52 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"500\",\"total_count\":\"1\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/clinical_conditions\\/544501615\",\"id\":\"544501615\",\"condition_name\":\"32\",\"tooth_surface\":\"Tooth & Surface Required\",\"description\":\"108\",\"status\":\"Active\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"31046554-e5ff-4268-b8a9-0eca295850d6"},{"name":"drugs","id":"7ecc87cc-af8f-4108-a5f1-6e458743fadd","request":{"method":"GET","header":[],"url":"{{url}}/drugs?request_key={{request_key}}","description":"

Get the full list of drugs collection with all information and expandable urls

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
drug_id	drug id as per practice management system	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
drug_id	drug id as per practice management system

","urlObject":{"path":["drugs"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"e64fe991-d6bf-472f-8272-6d0b65339059","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/drugs?request_key=request_key","host":["{{url}}"],"path":["drugs"],"query":[{"key":"request_key","value":"request_key"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1112","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 01 May 2017 04:30:37 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"500\",\n \"total_count\": \"61\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/drugs/64\",\n \"drug_id\": \"64\",\n \"date\": \"\",\n \"name\": \"Zithromax Suspension\",\n \"description\": \"Zithromax Suspension 200mg/5ml\",\n \"quantity\": \"16ml bottle\",\n \"refills\": \"0\",\n \"quantity_generic\": \"0\",\n \"refill_od\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"directions\": \"first day 1 tsp second day 1 tsp for 5 days\",\n \"notes\": \"\",\n \"is_prescribed_by_office\": \"Active\",\n \"status\": \"Active\",\n \"trigger_about_medical_alert\": \"Inactive\",\n \"drug_enforcement_administration_number\": \"Active\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/drugs/63\",\n \"drug_id\": \"63\",\n \"date\": \"\",\n \"name\": \"Fioricet\",\n \"description\": \"Fioricet\",\n \"quantity\": \"20\",\n \"refills\": \"0\",\n \"quantity_generic\": \"0\",\n \"refill_od\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"directions\": \"Take 1 Tab every 4 hours as needed for pain.\",\n \"notes\": \"\",\n \"is_prescribed_by_office\": \"Active\",\n \"status\": \"Active\",\n \"trigger_about_medical_alert\": \"Inactive\",\n \"drug_enforcement_administration_number\": \"Active\"\n }\n ]\n }\n]"}],"_postman_id":"7ecc87cc-af8f-4108-a5f1-6e458743fadd"},{"name":"drugs by drug_id","id":"ab949442-6e67-4bde-9b4b-b0dba782b763","request":{"method":"GET","header":[],"url":"{{url}}/drugs/{drug_id}?request_key={{request_key}}","description":"

Get the detail information about drug and expand on request. It contains drug details.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
drug_id	drug id as per practice management system	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
drug_id	drug id as per practice management system

","urlObject":{"path":["drugs","{drug_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"fbfedd91-058b-40bf-85af-e234b215e7e4","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/drugs/{drug_id}?request_key=request_key","host":["{{url}}"],"path":["drugs","{drug_id}"],"query":[{"key":"request_key","value":"request_key"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"574","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 01 May 2017 04:36:07 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"500\",\"total_count\":\"1\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/drugs\\/62\",\"drug_id\":\"62\",\"date\":\"\",\"name\":\"Amoxicillin 500 mg\",\"description\":\"Amoxicillin 500 mg\",\"quantity\":\"28 tabs\",\"refills\":\"0\",\"quantity_generic\":\"0\",\"refill_od\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"directions\":\"Take 1 tab q.i.d. until gone\",\"notes\":\"\",\"is_prescribed_by_office\":\"Active\",\"status\":\"Active\",\"trigger_about_medical_alert\":\"Inactive\",\"drug_enforcement_administration_number\":\"Active\"}]}]\r\n"}],"_postman_id":"ab949442-6e67-4bde-9b4b-b0dba782b763"},{"name":"employers","id":"1bba3c89-b793-4157-a92e-978b093f74b1","request":{"method":"GET","header":[],"url":"{{url}}/employers?request_key={{request_key}}","description":"

Get the full list of employers collection with all information and expandable urls

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
employer_id	employer id as per practice management system	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
employer_id	employer id as per practice management system
employer_name	Employer Name

","urlObject":{"path":["employers"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"24d05b07-7f29-429d-b94a-8e80bcd12d5c","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/employers?request_key={{request_key}}","host":["{{url}}"],"path":["employers"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"744","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 11:13:35 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"1031\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/1118_466\",\"employer_id\":\"1118_466\",\"name\":\"Self\\/ American Republic\",\"address_line1\":\"address\",\"address_line2\":\"\",\"city\":\"city\",\"state\":\"state\",\"zipcode\":\"95035\",\"country\":\"\",\"phone\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/1117_38\",\"employer_id\":\"1117_38\",\"name\":\"Painters District Councel #30\",\"address_line1\":\"address\",\"address_line2\":\"\",\"city\":\"city\",\"state\":\"state\",\"zipcode\":\"95035\",\"country\":\"\",\"phone\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"1bba3c89-b793-4157-a92e-978b093f74b1"},{"name":"employers by employer_id","id":"4af6d8d7-5e5a-41f5-b7d4-904be27a0e91","request":{"method":"GET","header":[],"url":"{{url}}/employers/{employer_id}?request_key={{request_key}}","description":"

Get the detail information about employer and expand on request. It contains employers name , contact & id.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
employer_id	employer id as per practice management system	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
employer_id	employer id as per practice management system
employer_name	Employer Name

","urlObject":{"path":["employers","{employer_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"45dc7533-4e66-46e9-b9d7-2b17a36d8038","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/employers/{employer_id}?request_key={{request_key}}","host":["{{url}}"],"path":["employers","{employer_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"341","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 11:17:34 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/1118_466\",\"employer_id\":\"1118_466\",\"name\":\"Self\\/ American Republic\",\"address_line1\":\"address\",\"address_line2\":\"\",\"city\":\"city\",\"state\":\"state\",\"zipcode\":\"95035\",\"country\":\"\",\"phone\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"4af6d8d7-5e5a-41f5-b7d4-904be27a0e91"},{"name":"payment_types","id":"bec4e32b-6ea0-48a5-8616-20b7e67ffb5d","request":{"method":"GET","header":[],"url":"{{url}}/payment_types?request_key={{request_key}}","description":"

Get the list of all payment types with the information like code , description.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
code	valid code, coma separated for multiple	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
code	valid code, coma separated for multiple

","urlObject":{"path":["payment_types"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"98838a16-105f-4914-bc09-d0fa3096a3cc","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/payment_types?request_key={{request_key}}","host":["{{url}}"],"path":["payment_types"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"464","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 06:48:23 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"31\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/payment_types\\/9\",\"code\":\"9\",\"description\":\"Money Order\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/payment_types\\/8\",\"code\":\"8\",\"description\":\"Discover- Mailed\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"bec4e32b-6ea0-48a5-8616-20b7e67ffb5d"},{"name":"payment_types by code","id":"ceec1d53-f572-4c4e-b6af-647977fec0c7","request":{"method":"GET","header":[],"url":"{{url}}/payment_types/{code}?request_key={{request_key}}","description":"

Get the code , description and practice id about payment type

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
code	valid code, coma separated for multiple	No

Sortby

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
code	valid code, coma separated for multiple

","urlObject":{"path":["payment_types","{code}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"062d2e19-1c03-44c6-8518-f0a2f57482ff","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/payment_types/{code}?request_key={{request_key}}","host":["{{url}}"],"path":["payment_types","{code}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"201","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 06:57:42 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/payment_types\\/9\",\"code\":\"9\",\"description\":\"Money Order\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"ceec1d53-f572-4c4e-b6af-647977fec0c7"},{"name":"providers","id":"97203048-3ab5-4716-8fa4-53385b9c393c","request":{"method":"GET","header":[],"url":"{{url}}/providers?request_key={{request_key}}","description":"

Get the list of all providers.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
provider_type	Valid Provider type, coma separated for multiple	No
provider_id	Provider id as per practice management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
provider_id	Provider id as per practice management system

","urlObject":{"path":["providers"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"bb5077c6-a0db-48d5-bb85-3eb51e3d5664","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/providers?request_key={{request_key}}","host":["{{url}}"],"path":["providers"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1591","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:25:16 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"35\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/VLP\",\"provider_id\":\"VLP\",\"firstname\":\"Vdfdd\",\"lastname\":\"Ztedda\",\"address_line1\":\"1astde\",\"address_line2\":\"Last Day 11-30-11\",\"city\":\"Lewistown\",\"state\":\"IL\",\"zipcode\":\"61542\",\"country\":\"\",\"phone\":\"\",\"provider_type\":\"Provider\",\"specialty\":\"Dental Assistant\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"patients\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients?provider_id=VLP\"},\"appointments\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/appointments?provider_id=VLP\"},\"status\":\"Inactive\",\"provider_account_id\":\"\",\"state_id\":\"\",\"tax_identification_number\":\"\",\"medicaid_id\":\"\",\"drug_id\":\"\",\"national_provider_identifier\":\"\",\"email\":\"\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/TLD\",\"provider_id\":\"TLD\",\"firstname\":\"Tastde\",\"lastname\":\"Ztedda\",\"address_line1\":\"5poie\",\"address_line2\":\"Apt. B\",\"city\":\"Peoria\",\"state\":\"IL\",\"zipcode\":\"61615\",\"country\":\"\",\"phone\":\"\",\"provider_type\":\"Provider\",\"specialty\":\"Dental Assistant\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"patients\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients?provider_id=TLD\"},\"appointments\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/appointments?provider_id=TLD\"},\"status\":\"Inactive\",\"provider_account_id\":\"\",\"state_id\":\"\",\"tax_identification_number\":\"\",\"medicaid_id\":\"\",\"drug_id\":\"\",\"national_provider_identifier\":\"\",\"email\":\"\"}]}]\r\n"}],"_postman_id":"97203048-3ab5-4716-8fa4-53385b9c393c"},{"name":"providers by provider_id","id":"a6916ccd-0d31-4274-b7d1-8a30bead05c8","request":{"method":"GET","header":[],"url":"{{url}}/providers/{provider_id}?request_key={{request_key}}","description":"

Get the information of provider based on provider id.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
provider_type	Valid Provider type, coma separated for multiple	No
provider_id	Provider id as per practice management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
provider_id	Provider id as per practice management system

","urlObject":{"path":["providers","{provider_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"3187659e-0572-479b-acdb-31f46198490b","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/providers/{provider_id}?request_key={{request_key}}","host":["{{url}}"],"path":["providers","{provider_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"774","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:27:37 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/VLP\",\"provider_id\":\"VLP\",\"firstname\":\"Vdfdd\",\"lastname\":\"Ztedda\",\"address_line1\":\"1astde\",\"address_line2\":\"Last Day 11-30-11\",\"city\":\"Lewistown\",\"state\":\"IL\",\"zipcode\":\"61542\",\"country\":\"\",\"phone\":\"\",\"provider_type\":\"Provider\",\"specialty\":\"Dental Assistant\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"patients\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients?provider_id=VLP\"},\"appointments\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/appointments?provider_id=VLP\"},\"status\":\"Inactive\",\"provider_account_id\":\"\",\"state_id\":\"\",\"tax_identification_number\":\"\",\"medicaid_id\":\"\",\"drug_id\":\"\",\"national_provider_identifier\":\"\",\"email\":\"\"}\r\n"}],"_postman_id":"a6916ccd-0d31-4274-b7d1-8a30bead05c8"},{"name":"referrals","id":"62084266-7b6e-4fc8-b266-1f8daccc1fec","request":{"method":"GET","header":[],"url":"{{url}}/referrals?request_key={{request_key}}","description":"

\"Referrals\" API will return the collection of all referrals

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
referral_id	Referral ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
referral_id	Referral ID

","urlObject":{"path":["referrals"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"6e38be4e-1ce7-41ba-b5eb-60c672eae2c2","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/referrals?request_key={{request_key}}","host":["{{url}}"],"path":["referrals"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1471","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:21:18 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"258\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/referrals/86\",\n \"referral_id\": \"86\",\n \"referral_type\": \"FromPat\",\n \"firstname\": \"DEMO\",\n \"middlename\": \"M\",\n \"lastname\": \"FIRST\",\n \"speciality\": \"0\",\n \"salutation\": \"Owner\",\n \"title\": \"Ias\",\n \"email\": \"satyen.pandya@sikkasoftware.com\",\n \"fax\": \"(xxx)-xxx-xxxx\",\n \"otherphone\": \"(xxx)-xxx-xxxx\",\n \"address_line1\": \"922-xxx street\",\n \"address_line2\": \"\",\n \"city\": \"Chino\",\n \"state\": \"Ontario\",\n \"zipcode\": \"64513\",\n \"phone\": \"(xxx)-xxx-xxxx\",\n \"ext\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/2/referrals/87\",\n \"referral_id\": \"87\",\n \"referral_type\": \"FromPat\",\n \"firstname\": \"DEMO\",\n \"middlename\": \"M\",\n \"lastname\": \"SECOND\",\n \"speciality\": \"0\",\n \"salutation\": \"Owner\",\n \"title\": \"Ias\",\n \"email\": \"satyen.pandya@sikkasoftware.com\",\n \"fax\": \"(xxx)-xxx-xxxx\",\n \"otherphone\": \"(xxx)-xxx-xxxx\",\n \"address_line1\": \"922-xxx street\",\n \"address_line2\": \"\",\n \"city\": \"Chino\",\n \"state\": \"Ontario\",\n \"zipcode\": \"64513\",\n \"phone\": \"(xxx)-xxx-xxxx\",\n \"ext\": \"\",\n \"practice_id\": \"2\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/2\"\n }\n }\n ]\n }\n]"}],"_postman_id":"62084266-7b6e-4fc8-b266-1f8daccc1fec"},{"name":"referrals by referral_id","id":"dd626d77-a460-41d9-bb0d-63b30fd2998c","request":{"method":"GET","header":[],"url":"{{url}}/referrals/{referral_id}?request_key={{request_key}}","description":"

Get the information of referral as per the referral id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
referral_id	Referral ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
referral_id	Referral ID

","urlObject":{"path":["referrals","{referral_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"e230e199-fa37-4bf7-a6c2-557e725075ff","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/referrals/{referral_id}?request_key={{request_key}}","host":["{{url}}"],"path":["referrals","{referral_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"708","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:23:07 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"500\",\n \"total_count\": \"1\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/referrals/86\",\n \"referral_id\": \"86\",\n \"referral_type\": \"FromPat\",\n \"firstname\": \"DEMO\",\n \"middlename\": \"M\",\n \"lastname\": \"FIRST\",\n \"speciality\": \"0\",\n \"salutation\": \"Owner\",\n \"title\": \"Ias\",\n \"email\": \"satyen.pandya@sikkasoftware.com\",\n \"fax\": \"(xxx)-xxx-xxxx\",\n \"otherphone\": \"(xxx)-xxx-xxxx\",\n \"address_line1\": \"922-xxx street\",\n \"address_line2\": \"\",\n \"city\": \"Chino\",\n \"state\": \"Ontario\",\n \"zipcode\": \"64513\",\n \"phone\": \"(xxx)-xxx-xxxx\",\n \"ext\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n }\n ]\n }\n]"}],"_postman_id":"dd626d77-a460-41d9-bb0d-63b30fd2998c"},{"name":"practice_variables","id":"3dab1d17-535b-44d6-bf98-c156750eb3de","request":{"method":"GET","header":[],"url":"{{url}}/practice_variables?request_key={{request_key}}","description":"

‘Practice_variables’ endpoint will map appointment status with its description. Appointments data sometime do return appointment status as 'appointment code' + 'appointment description'. it is combination of appointment code and its description.

\n
$\"practice_variables\"$
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
service_name	Service name as per the response	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
service_name	Service name as per the response

","urlObject":{"path":["practice_variables"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"df71c508-1d85-48e3-9d86-10cc304afb51","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/practice_variables?request_key={{request_key}}","host":["{{url}}"],"path":["practice_variables"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1471","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:21:18 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\r\n\t\"offset\": \"0\",\r\n\t\"limit\": \"500\",\r\n\t\"total_count\": \"4\",\r\n\t\"execution_time\": \"35\",\r\n\t\"items\": [{\r\n\t\t\"href\": \"https://api.sikkasoft.com/v2/practices/1/practice_variables\",\r\n\t\t\"service_name\": \"Appointment Status\",\r\n\t\t\"value\": \"open.unconfirm\",\r\n\t\t\"description\": \"open.unconfirm\",\r\n\t\t\"practice_id\": \"1\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://api.sikkasoft.com/v2/practices/1\"\r\n\t\t}\r\n\t}, {\r\n\t\t\"href\": \"https://api.sikkasoft.com/v2/practices/1/practice_variables\",\r\n\t\t\"service_name\": \"Appointment Status\",\r\n\t\t\"value\": \"open.confirm\",\r\n\t\t\"description\": \"open.confirm\",\r\n\t\t\"practice_id\": \"1\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://api.sikkasoft.com/v2/practices/1\"\r\n\t\t}\r\n\t}, {\r\n\t\t\"href\": \"https://api.sikkasoft.com/v2/practices/1/practice_variables\",\r\n\t\t\"service_name\": \"Appointment Status\",\r\n\t\t\"value\": \"complete.unconfirm\",\r\n\t\t\"description\": \"complete.unconfirm\",\r\n\t\t\"practice_id\": \"1\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://api.sikkasoft.com/v2/practices/1\"\r\n\t\t}\r\n\t}, {\r\n\t\t\"href\": \"https://api.sikkasoft.com/v2/practices/1/practice_variables\",\r\n\t\t\"service_name\": \"Appointment Status\",\r\n\t\t\"value\": \"complete.confirm\",\r\n\t\t\"description\": \"complete.confirm\",\r\n\t\t\"practice_id\": \"1\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://api.sikkasoft.com/v2/practices/1\"\r\n\t\t}\r\n\t}]\r\n}]"}],"_postman_id":"3dab1d17-535b-44d6-bf98-c156750eb3de"}],"id":"de8d3d48-9ad5-495b-9cac-ef5cf5b606aa","description":"

These APIs contain information about practice status , reports , account receivables , drugs , employers , providers etc.

\n","_postman_id":"de8d3d48-9ad5-495b-9cac-ef5cf5b606aa"},{"name":"Appointments ","item":[{"name":"appointments","id":"fb521f93-4a19-4391-82f8-84a501d9943c","request":{"method":"GET","header":[],"url":"{{url}}/appointments?request_key={{request_key}}","description":"

Get the list of all appointments available in practice management system.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
startdate	format: yyyy-mm-dd, start date	No
enddate	format: yyyy-mm-dd, end date	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
appointment_sr_no	Appointment serial number
patient_id	Patient ID as per the management system
appointment_date	Appointment Date
appointment_time	Appointment Time

","urlObject":{"path":["appointments"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"dfb1ada9-31fc-40f2-95a9-4f2d3fed89e6","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/appointments?request_key={{request_key}}","host":["{{url}}"],"path":["appointments"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"2936","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 10:20:30 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"28039\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments/99458\",\n \"appointment_sr_no\": \"99458\",\n \"patient_id\": \"2963\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/2963\"\n },\n \"operatory\": \"Lynns Room 2\",\n \"date\": \"2016-10-27\",\n \"time\": \"13:30\",\n \"length\": \"90\",\n \"description\": \"\",\n \"amount\": \"293.0000\",\n \"status\": \"Unconfirmed\",\n \"last_changed_date\": \"\",\n \"appointment_made_date\": \"2016-04-21\",\n \"type\": \"Prophy Lynn\",\n \"procedure_code1\": \"00120\",\n \"procedure_code1_amount\": \"54\",\n \"procedure_code2\": \"00210\",\n \"procedure_code2_amount\": \"145\",\n \"procedure_code3\": \"01110\",\n \"procedure_code3_amount\": \"94\",\n \"procedure_code4\": \"\",\n \"procedure_code4_amount\": \"0\",\n \"procedure_code5\": \"\",\n \"procedure_code5_amount\": \"0\",\n \"procedure_code6\": \"\",\n \"procedure_code6_amount\": \"0\",\n \"procedure_code7\": \"\",\n \"procedure_code7_amount\": \"0\",\n \"hygienist\": \"\",\n \"provider_id\": \"LW\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/LW\"\n },\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"is_companion\": \"\",\n \"sooner_if_possible\": \"N\",\n \"confirmed_on_date\": \"\",\n \"note\": \"FMX 6MRC OHI OSHA TTHPS TBRSH CLEAN RECAL\",\n \"patient_name\": \"John Wiesbrock\",\n \"guarantor_id\": \"\",\n \"guarantor_name\": \"\",\n \"procedure_code1_time\": \"0\",\n \"procedure_code2_time\": \"0\",\n \"procedure_code3_time\": \"0\",\n \"procedure_code4_time\": \"0\",\n \"procedure_code5_time\": \"0\",\n \"procedure_code6_time\": \"0\",\n \"procedure_code7_time\": \"0\",\n \"tooth_number\": \"\",\n \"surface_quadrant\": \"\",\n \"surface_quadrant_type\": \"\",\n \"schedule\": \"Fixed\",\n \"treatment_class\": \"\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments/99457\",\n \"appointment_sr_no\": \"99457\",\n \"patient_id\": \"5867\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/5867\"\n },\n \"operatory\": \"Lynns Room 2\",\n \"date\": \"2016-08-18\",\n \"time\": \"08:00\",\n \"length\": \"60\",\n \"description\": \"\",\n \"amount\": \"213.0000\",\n \"status\": \"Unconfirmed\",\n \"last_changed_date\": \"\",\n \"appointment_made_date\": \"2016-04-21\",\n \"type\": \"Prophy Lynn\",\n \"procedure_code1\": \"00120\",\n \"procedure_code1_amount\": \"54\",\n \"procedure_code2\": \"04910\",\n \"procedure_code2_amount\": \"159\",\n \"procedure_code3\": \"\",\n \"procedure_code3_amount\": \"0\",\n \"procedure_code4\": \"\",\n \"procedure_code4_amount\": \"0\",\n \"procedure_code5\": \"\",\n \"procedure_code5_amount\": \"0\",\n \"procedure_code6\": \"\",\n \"procedure_code6_amount\": \"0\",\n \"procedure_code7\": \"\",\n \"procedure_code7_amount\": \"0\",\n \"hygienist\": \"\",\n \"provider_id\": \"LW\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/LW\"\n },\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"is_companion\": \"\",\n \"sooner_if_possible\": \"N\",\n \"confirmed_on_date\": \"\",\n \"note\": \"OHI 4MRC OSHA TTHPS TBRSH RECAL 04910\",\n \"patient_name\": \"James Evenhuis\",\n \"guarantor_id\": \"\",\n \"guarantor_name\": \"\",\n \"procedure_code1_time\": \"0\",\n \"procedure_code2_time\": \"0\",\n \"procedure_code3_time\": \"0\",\n \"procedure_code4_time\": \"0\",\n \"procedure_code5_time\": \"0\",\n \"procedure_code6_time\": \"0\",\n \"procedure_code7_time\": \"0\",\n \"tooth_number\": \"\",\n \"surface_quadrant\": \"\",\n \"surface_quadrant_type\": \"\",\n \"schedule\": \"Fixed\",\n \"treatment_class\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"fb521f93-4a19-4391-82f8-84a501d9943c"},{"name":"appointments by appointment_sr_no","id":"c910c67e-1b53-46c8-922f-7d824a09f033","request":{"method":"GET","header":[],"url":"{{url}}/appointments/{appointment_sr_no}?request_key={{request_key}}","description":"

Get the appointment available in practice management system.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
startdate	format: yyyy-mm-dd, start date	No
enddate	format: yyyy-mm-dd, end date	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
appointment_sr_no	Appointment serial number
patient_id	Patient ID as per the management system
appointment_date	Appointment Date
appointment_time	Appointment Time

","urlObject":{"path":["appointments","{appointment_sr_no}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"52b576e6-0ecf-4cf6-b1ce-34efd44c744d","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/appointments/{{appointment_sr_no}}?request_key={{request_key}}","host":["{{url}}"],"path":["appointments","{{appointment_sr_no}}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1443","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 10:24:56 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments/99458\",\n \"appointment_sr_no\": \"99458\",\n \"patient_id\": \"2963\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/2963\"\n },\n \"operatory\": \"Lynns Room 2\",\n \"date\": \"2016-10-27\",\n \"time\": \"13:30\",\n \"length\": \"90\",\n \"description\": \"\",\n \"amount\": \"293.0000\",\n \"status\": \"Unconfirmed\",\n \"last_changed_date\": \"\",\n \"appointment_made_date\": \"2016-04-21\",\n \"type\": \"Prophy Lynn\",\n \"procedure_code1\": \"00120\",\n \"procedure_code1_amount\": \"54\",\n \"procedure_code2\": \"00210\",\n \"procedure_code2_amount\": \"145\",\n \"procedure_code3\": \"01110\",\n \"procedure_code3_amount\": \"94\",\n \"procedure_code4\": \"\",\n \"procedure_code4_amount\": \"0\",\n \"procedure_code5\": \"\",\n \"procedure_code5_amount\": \"0\",\n \"procedure_code6\": \"\",\n \"procedure_code6_amount\": \"0\",\n \"procedure_code7\": \"\",\n \"procedure_code7_amount\": \"0\",\n \"hygienist\": \"\",\n \"provider_id\": \"LW\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/LW\"\n },\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"is_companion\": \"\",\n \"sooner_if_possible\": \"N\",\n \"confirmed_on_date\": \"\",\n \"note\": \"FMX 6MRC OHI OSHA TTHPS TBRSH CLEAN RECAL\",\n \"patient_name\": \"John Wiesbrock\",\n \"guarantor_id\": \"\",\n \"guarantor_name\": \"\",\n \"procedure_code1_time\": \"0\",\n \"procedure_code2_time\": \"0\",\n \"procedure_code3_time\": \"0\",\n \"procedure_code4_time\": \"0\",\n \"procedure_code5_time\": \"0\",\n \"procedure_code6_time\": \"0\",\n \"procedure_code7_time\": \"0\",\n \"tooth_number\": \"\",\n \"surface_quadrant\": \"\",\n \"surface_quadrant_type\": \"\",\n \"schedule\": \"Fixed\",\n \"treatment_class\": \"\"\n}"}],"_postman_id":"c910c67e-1b53-46c8-922f-7d824a09f033"},{"name":"appointments/{appointment_sr_no}","id":"b1139d62-c578-490d-9563-ac12095482a0","request":{"method":"DELETE","header":[],"url":"{{url}}/appointments/{appointment_sr_no}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes

Display all the appointment status available in practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID

","urlObject":{"path":["appointment_statuses"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"70d3dc49-e8a4-4579-a068-8fcb4ca78da0","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/appointment_statuses?request_key={{request_key}}","host":["{{url}}"],"path":["appointment_statuses"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"454","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 10:11:25 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"8\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/appointment_statuses\\/No Answer\",\"status\":\"No Answer\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/appointment_statuses\\/Sent Email\",\"status\":\"Sent Email\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"74b80c7d-1c04-4abb-b66e-0da44dc83d37"},{"name":"appointment_statuses by status","id":"47ab4160-73e1-4966-b676-f5f2e8451b4e","request":{"method":"GET","header":[],"url":"{{url}}/appointment_statuses/{status}?request_key={{request_key}}","description":"

Get the resource of appointment status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID

","urlObject":{"path":["appointment_statuses","{status}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"aff4fa7a-c975-48ee-a779-899fc5c2e2f5","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/appointment_statuses/{{status}}?request_key={{request_key}}","host":["{{url}}"],"path":["appointment_statuses","{{status}}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"198","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 10:14:42 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/appointment_statuses\\/No Answer\",\"status\":\"No Answer\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"47ab4160-73e1-4966-b676-f5f2e8451b4e"}],"id":"3f97945b-b182-47fb-a94d-fcde293afa09","description":"

It contains all APIs related with appointments in practice.

\n","_postman_id":"3f97945b-b182-47fb-a94d-fcde293afa09"},{"name":"Claims","item":[{"name":"claims","id":"c5fd6fdd-fc94-4a7c-9260-60c06e5d20c6","request":{"method":"GET","header":[],"url":"{{url}}/claims?request_key={{request_key}}","description":"

Get the list of all claim information from practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
guarantor_id	Guarantor id as per practice management systems	No
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
claim_sr_no	Claim serial number
claim_sent_date	Claim Sent Date
claim_payment_date	Claim Payment Date
total_billed_amount	Total Billed Amount
estimated_amount	Estimated Amount
payment_amount	Payment Amount

","urlObject":{"path":["claims"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"40a5f03e-bd24-43f4-b68a-92625a6f5dd9","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/claims?request_key={{request_key}}","host":["{{url}}"],"path":["claims"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"2250","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 10:51:03 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"40464\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/claims\\/41660\",\"claim_sr_no\":\"41660\",\"claim_description_id\":\"41660\",\"patient_id\":\"2963\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/2963\"},\"guarantor_id\":\"2963\",\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/2963\"},\"provider_id\":\"DR\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"claim_sent_date\":\"\",\"total_billed_amount\":\"186.0000\",\"estimated_amount\":\"72.0000\",\"claim_payment_date\":\"\",\"payment_amount\":\"0.0000\",\"claim_status\":\"U\",\"primary_or_secondary\":\"Secondary\",\"insurance_company_id\":\"995\",\"insurance_company\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_companies\\/995\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"claim_description\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/claim_descriptions\\/41660\"},\"insurance_company_name\":\"Met Life-TDP Dental Unit\",\"claim_channel\":\"Unsubmitted\",\"note\":\"\",\"rendering_provider\":\"DR\",\"payer_id\":\"65978\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/claims\\/41660\",\"claim_sr_no\":\"41660\",\"claim_description_id\":\"41660\",\"patient_id\":\"2963\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/2963\"},\"guarantor_id\":\"2963\",\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/2963\"},\"provider_id\":\"DR\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"claim_sent_date\":\"2016-04-21\",\"total_billed_amount\":\"186.0000\",\"estimated_amount\":\"72.0000\",\"claim_payment_date\":\"\",\"payment_amount\":\"0.0000\",\"claim_status\":\"O\",\"primary_or_secondary\":\"Primary\",\"insurance_company_id\":\"257\",\"insurance_company\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_companies\\/257\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"claim_description\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/claim_descriptions\\/41660\"},\"insurance_company_name\":\"Blue Cross And Blue Shield Of Illinois\",\"claim_channel\":\"Printed\",\"note\":\"\",\"rendering_provider\":\"DR\",\"payer_id\":\"00621\"}]}]\r\n"}],"_postman_id":"c5fd6fdd-fc94-4a7c-9260-60c06e5d20c6"},{"name":"claims by claim_sr_no","id":"7a666723-ee4c-4c0b-850e-73426b86dbae","request":{"method":"GET","header":[],"url":"{{url}}/claims/{claim_sr_no}?request_key={{request_key}}","description":"

Get the information about claim as per claim serial number. Like claim status , sent date, payment amount , billed amount , estimated amount, provider id , patient id , guarantor id etc.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
guarantor_id	Guarantor id as per practice management systems	No
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
claim_sr_no	Claim serial number
claim_sent_date	Claim Sent Date
claim_payment_date	Claim Payment Date
total_billed_amount	Total Billed Amount
estimated_amount	Estimated Amount
payment_amount	Payment Amount

","urlObject":{"path":["claims","{claim_sr_no}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"95012f02-2cbd-42f4-ad41-8e9a85b85b95","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/claims/{{claim_sr_no}}?request_key={{request_key}}","host":["{{url}}"],"path":["claims","{{claim_sr_no}}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1104","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 10:55:26 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/claims\\/41659\",\"claim_sr_no\":\"41659\",\"claim_description_id\":\"41659\",\"patient_id\":\"2780\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/2780\"},\"guarantor_id\":\"2780\",\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/2780\"},\"provider_id\":\"DR\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"claim_sent_date\":\"2016-04-21\",\"total_billed_amount\":\"291.0000\",\"estimated_amount\":\"160.8000\",\"claim_payment_date\":\"\",\"payment_amount\":\"0.0000\",\"claim_status\":\"O\",\"primary_or_secondary\":\"Primary\",\"insurance_company_id\":\"1118\",\"insurance_company\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_companies\\/1118\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"claim_description\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/claim_descriptions\\/41659\"},\"insurance_company_name\":\"American Republic Insurance Company\",\"claim_channel\":\"Printed\",\"note\":\"\",\"rendering_provider\":\"DR\",\"payer_id\":\"CX092\"}\r\n"}],"_postman_id":"7a666723-ee4c-4c0b-850e-73426b86dbae"},{"name":"claim_descriptions","id":"5e300b0d-b6f5-4236-a554-0e647066cba8","request":{"method":"GET","header":[],"url":"{{url}}/claim_descriptions?request_key={{request_key}}","description":"

Get the collections of all claim descriptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
claim_description_id	Claim Description ID

","urlObject":{"path":["claim_descriptions"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"ace9aa65-871b-4133-b0d1-04a71af52631","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/claim_descriptions?request_key={{request_key}}","host":["{{url}}"],"path":["claim_descriptions"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1698","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 10:37:36 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"38816\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/claim_descriptions\\/41660\",\"claim_description_id\":\"41660\",\"ortho_treatment_plan_date\":\"\",\"first_visit_date_current_series\":\"\",\"occupant_status\":\"N\",\"occupant_description\":\"\",\"accident_status\":\"\",\"accident_description\":\"\",\"prosthesis\":\"\",\"replace_reason\":\"\",\"orthodontic_treat\":\"N\",\"mos_remian\":\"\",\"another_plan\":\"\",\"plan_desc\":\"\",\"place_of_treat\":\"Office\",\"xray_model_how_many\":\"\",\"school_city\":\"\",\"student_status\":\"\",\"auto_accident_date\":\"\",\"pre_autho_no\":\"\",\"prior_date\":\"\",\"oral\":\"N\",\"special\":\"\",\"ordered_date\":\"\",\"eligibility\":\"\",\"medicare\":\"\",\"retroactive\":\"\",\"chdp\":\"\",\"ccs\":\"\",\"re_eval\":\"\",\"ext\":\"\",\"orig_ref_no\":\"\",\"pla_of_treat\":\"\",\"occurance_date\":\"\",\"ins_ref\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/claim_descriptions\\/41659\",\"claim_description_id\":\"41659\",\"ortho_treatment_plan_date\":\"\",\"first_visit_date_current_series\":\"\",\"occupant_status\":\"N\",\"occupant_description\":\"\",\"accident_status\":\"\",\"accident_description\":\"\",\"prosthesis\":\"\",\"replace_reason\":\"\",\"orthodontic_treat\":\"N\",\"mos_remian\":\"\",\"another_plan\":\"\",\"plan_desc\":\"\",\"place_of_treat\":\"Office\",\"xray_model_how_many\":\"\",\"school_city\":\"\",\"student_status\":\"\",\"auto_accident_date\":\"\",\"pre_autho_no\":\"\",\"prior_date\":\"\",\"oral\":\"N\",\"special\":\"\",\"ordered_date\":\"\",\"eligibility\":\"\",\"medicare\":\"\",\"retroactive\":\"\",\"chdp\":\"\",\"ccs\":\"\",\"re_eval\":\"\",\"ext\":\"\",\"orig_ref_no\":\"\",\"pla_of_treat\":\"\",\"occurance_date\":\"\",\"ins_ref\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"5e300b0d-b6f5-4236-a554-0e647066cba8"},{"name":"claim_descriptions by claim_description_id","id":"3ff49fbb-26f2-42e8-b701-6f65b1ca41ec","request":{"method":"GET","header":[],"url":"{{url}}/claim_descriptions/{claim_description_id}?request_key={{request_key}}","description":"

Get the information about claim description as per claim description id. it contains claim description, status , date , accident description , reason for replace etc.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
claim_description_id	Claim Description ID

","urlObject":{"path":["claim_descriptions","{claim_description_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"d250ab47-fb28-4a77-acb1-d33fdf366249","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/claim_descriptions/{{claim_description_id}}?request_key={{request_key}}","host":["{{url}}"],"path":["claim_descriptions","{{claim_description_id}}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"878","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 10:40:03 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"500\",\"total_count\":\"1\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/claim_descriptions\\/41660\",\"claim_description_id\":\"41660\",\"ortho_treatment_plan_date\":\"\",\"first_visit_date_current_series\":\"\",\"occupant_status\":\"N\",\"occupant_description\":\"\",\"accident_status\":\"\",\"accident_description\":\"\",\"prosthesis\":\"\",\"replace_reason\":\"\",\"orthodontic_treat\":\"N\",\"mos_remian\":\"\",\"another_plan\":\"\",\"plan_desc\":\"\",\"place_of_treat\":\"Office\",\"xray_model_how_many\":\"\",\"school_city\":\"\",\"student_status\":\"\",\"auto_accident_date\":\"\",\"pre_autho_no\":\"\",\"prior_date\":\"\",\"oral\":\"N\",\"special\":\"\",\"ordered_date\":\"\",\"eligibility\":\"\",\"medicare\":\"\",\"retroactive\":\"\",\"chdp\":\"\",\"ccs\":\"\",\"re_eval\":\"\",\"ext\":\"\",\"orig_ref_no\":\"\",\"pla_of_treat\":\"\",\"occurance_date\":\"\",\"ins_ref\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"3ff49fbb-26f2-42e8-b701-6f65b1ca41ec"}],"id":"cb29f935-13ca-4993-9f0a-e47358c8ca8a","description":"

It contains APIs related with claim information

\n","_postman_id":"cb29f935-13ca-4993-9f0a-e47358c8ca8a"},{"name":"Fee Schedules ","item":[{"name":"fee_schedules","id":"b6e3a59b-ff05-4030-a68d-482995cb8052","request":{"method":"GET","header":[],"url":"{{url}}/fee_schedules?request_key={{request_key}}","description":"

Get he list of all fee schedules available in practice management system.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
fee_amount	Fee Amount
procedure_code	Procedure code as per practice management system

","urlObject":{"path":["fee_schedules"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"037439e4-dc7a-454a-aa03-d2c786482562","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/fee_schedules?request_key={{request_key}}","host":["{{url}}"],"path":["fee_schedules"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"559","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 08:45:36 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"3608\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/fee_schedules/ZTRAY\",\n \"procedure_code\": \"ZTRAY\",\n \"fee_no\": \"0\",\n \"fee_name\": \"default\",\n \"fee_amount\": \"206.0000\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/fee_schedules/ZTRAY\",\n \"procedure_code\": \"ZTRAY\",\n \"fee_no\": \"14\",\n \"fee_name\": \"Standard\",\n \"fee_amount\": \"206.0000\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n }\n ]\n }\n]"}],"_postman_id":"b6e3a59b-ff05-4030-a68d-482995cb8052"},{"name":"fee_schedules by procedure_code","id":"e400588d-f81b-4c84-b4cf-9109466e0221","request":{"method":"GET","header":[],"url":"{{url}}/fee_schedules/{procedure_code}?request_key={{request_key}}","description":"

Get the procedure code , fee number , fee amount , fee name as per procedure code.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
fee_amount	Fee Amount
procedure_code	Procedure code as per practice management system

","urlObject":{"path":["fee_schedules","{procedure_code}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"5b7ec54b-f795-4b4f-bcf3-4d901039a24b","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/fee_schedules/{procedure_code}?request_key={{request_key}}","host":["{{url}}"],"path":["fee_schedules","{procedure_code}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"249","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 08:50:05 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/fee_schedules\\/ZTRAY\",\"procedure_code\":\"ZTRAY\",\"fee_no\":\"0\",\"fee_name\":\"default\",\"fee_amount\":\"206.0000\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"e400588d-f81b-4c84-b4cf-9109466e0221"},{"name":"fee_schedule_bluebook","id":"1aa1bd94-cc16-47d6-8e45-eb390bef5b07","request":{"method":"GET","header":[],"url":"{{url}}/fee_schedule_bluebook?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
procedure_code	Procedure code as per practice management system

","urlObject":{"path":["fee_schedule_bluebook"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"ae5174b6-feb4-4875-b978-f9f4e882602c","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/fee_schedule_bluebook?request_key={{request_key}}","host":["{{url}}"],"path":["fee_schedule_bluebook"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1032","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 06:32:20 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"18534\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/fee_schedule_bluebook\\/999\",\"procedure_code\":\"999\",\"date\":\"2017-04-19\",\"insurance_company_id\":\"1265\",\"insurance_company\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_companies\\/1265\"},\"fee_amount\":\"50.0000\",\"insurance_payment\":\"50.0000\",\"allowed_amount\":\"50.0000\",\"percentage_covered\":\"100\",\"is_deductible\":\"0\",\"notes\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/fee_schedule_bluebook\\/999\",\"procedure_code\":\"999\",\"date\":\"2017-04-18\",\"insurance_company_id\":\"1278\",\"insurance_company\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_companies\\/1278\"},\"fee_amount\":\"50.0000\",\"insurance_payment\":\"7.5000\",\"allowed_amount\":\"50.0000\",\"percentage_covered\":\"15\",\"is_deductible\":\"0\",\"notes\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"1aa1bd94-cc16-47d6-8e45-eb390bef5b07"},{"name":"fee_schedule_bluebook by procedure_code","id":"a34af4f5-89d1-4c52-b922-7c5a6c4c4f66","request":{"method":"GET","header":[],"url":"{{url}}/fee_schedule_bluebook/{procedure_code}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
procedure_code	Procedure code as per practice management system

","urlObject":{"path":["fee_schedule_bluebook","{procedure_code}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"be75451c-54bd-45dd-9687-d0759ee1c63c","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/fee_schedule_bluebook/{procedure_code}?request_key={{request_key}}","host":["{{url}}"],"path":["fee_schedule_bluebook","{procedure_code}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"545","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 06:40:12 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"1\",\"total_count\":\"11\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/fee_schedule_bluebook\\/999\",\"procedure_code\":\"999\",\"date\":\"2017-04-19\",\"insurance_company_id\":\"1265\",\"insurance_company\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_companies\\/1265\"},\"fee_amount\":\"50.0000\",\"insurance_payment\":\"50.0000\",\"allowed_amount\":\"50.0000\",\"percentage_covered\":\"100\",\"is_deductible\":\"0\",\"notes\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"a34af4f5-89d1-4c52-b922-7c5a6c4c4f66"}],"id":"b91a2381-c25a-4977-9a08-b9e11f9bcf4c","description":"

It contains all APIs related with practice's fee schedule information

\n","_postman_id":"b91a2381-c25a-4977-9a08-b9e11f9bcf4c"},{"name":"Guarantors","item":[{"name":"guarantors","id":"111a4cd2-1d10-419e-a87c-805a0be93d38","request":{"method":"GET","header":[],"url":"{{url}}/guarantors?request_key={{request_key}}","description":"

Get the collection of all guarantors from practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
patient_id	Patient ID as per the management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
cell	Cell Number	No
phone	Phone Number	No
workphone	Work Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
guarantor_id	Guarantor id as per practice management systems
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["guarantors"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"52025937-f774-4a09-9ce2-6bc3b059dc7c","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/guarantors?request_key={{request_key}}","host":["{{url}}"],"path":["guarantors"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1619","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:44:01 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"5071\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/6070\",\n \"guarantor_id\": \"6070\",\n \"patient_id\": \"6070\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/6070\"\n },\n \"guarantor_s_patient_id\": \"\",\n \"firstname\": \"Ttedda\",\n \"middlename\": \"\",\n \"lastname\": \"Sqode\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1967-06-20\",\n \"employer_id\": \"1117\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"Peoria\",\n \"state\": \"IL\",\n \"zipcode\": \"61614\",\n \"phone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"guarantor_class\": \"\",\n \"email\": \"\",\n \"preferred_contact\": \"\",\n \"billing_type\": \"\",\n \"status\": \"A\",\n \"suspended_date\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/1117\"\n },\n \"country\": \"\",\n \"patient_firstname\": \"Test\",\n\t\t\t\t\"patient_lastname\": \"Test\",\n\t\t\t\t\"patient_middlename\": \"\",\n\t\t\t\t\"patient_status\": \"Active\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/6068\",\n \"guarantor_id\": \"6068\",\n \"patient_id\": \"6068\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/6068\"\n },\n \"guarantor_s_patient_id\": \"\",\n \"firstname\": \"Aastde\",\n \"middlename\": \"\",\n \"lastname\": \"Aqode\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1977-05-11\",\n \"employer_id\": \"0\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"Peoria\",\n \"state\": \"IL\",\n \"zipcode\": \"61614\",\n \"phone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"xxxxxxxxxx\",\n \"guarantor_class\": \"\",\n \"email\": \"\",\n \"preferred_contact\": \"\",\n \"billing_type\": \"\",\n \"status\": \"A\",\n \"suspended_date\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/0\"\n },\n \"country\": \"\",\n \"patient_firstname\": \"Test\",\n\t\t\t\t\"patient_lastname\": \"Test\",\n\t\t\t\t\"patient_middlename\": \"\",\n\t\t\t\t\"patient_status\": \"Active\"\n }\n ]\n }\n]"}],"_postman_id":"111a4cd2-1d10-419e-a87c-805a0be93d38"},{"name":"guarantors by guarantor_id","id":"b6830958-7b68-48eb-b833-f5bddb973240","request":{"method":"GET","header":[],"url":"{{url}}/guarantors/{guarantor_id}?request_key={{request_key}}","description":"

Get the information about guarantor based on guarantor id. This API call will return guarantor name , address, contact numbers ,status and many fields.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
patient_id	Patient ID as per the management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
cell	Cell Number	No
phone	Phone Number	No
workphone	Work Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
guarantor_id	Guarantor id as per practice management systems
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["guarantors","{guarantor_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"6cbde7ba-12c8-4bfe-8244-de8cded94a5d","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/guarantors/{guarantor_id}?request_key={{request_key}}","host":["{{url}}"],"path":["guarantors","{guarantor_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"778","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:47:21 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/6070\",\n \"guarantor_id\": \"6070\",\n \"patient_id\": \"6070\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/6070\"\n },\n \"guarantor_s_patient_id\": \"\",\n \"firstname\": \"Ttedda\",\n \"middlename\": \"\",\n \"lastname\": \"Sqode\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1967-06-20\",\n \"employer_id\": \"1117\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"Peoria\",\n \"state\": \"IL\",\n \"zipcode\": \"61614\",\n \"phone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"guarantor_class\": \"\",\n \"email\": \"\",\n \"preferred_contact\": \"\",\n \"billing_type\": \"\",\n \"status\": \"A\",\n \"suspended_date\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/1117\"\n },\n \"country\": \"\",\n \"patient_firstname\": \"Test\",\n \"patient_lastname\": \"Test\",\n\t\"patient_middlename\": \"\",\n\t\"patient_status\": \"Active\"\n}"}],"_postman_id":"b6830958-7b68-48eb-b833-f5bddb973240"},{"name":"guarantor_accounts","id":"63b8b37b-1c08-4648-a5fc-96796f5b684a","request":{"method":"GET","header":[],"url":"{{url}}/guarantor_accounts?request_key={{request_key}}","description":"

Get the list of all guarantor_accounts information from practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
provider_id	Provider id as per practice management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
phone	Phone Number	No
workphone	Work Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
guarantor_id	Guarantor id as per practice management systems
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["guarantor_accounts"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"e8877c1b-67f4-4fd3-900b-3a8b6d7e3137","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/guarantor_accounts?request_key={{request_key}}","host":["{{url}}"],"path":["guarantor_accounts"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"6841","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:30:05 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"3241\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantor_accounts\\/355600\",\"guarantor_id\":\"355600\",\"guarantor_1_firstname\":\"Test\",\"guarantor_1_lastname\":\"Demo\",\"guarantor_1_middlename\":\"\",\"guarantor_1_address_line1\":\"\",\"guarantor_1_address_line2\":\"\",\"guarantor_1_city\":\"Orlando\",\"guarantor_1_state\":\"FL\",\"guarantor_1_phone\":\"\",\"guarantor_1_workphone\":\"\",\"guarantor_1_salutation\":\"\",\"guarantor_1_birthdate\":\"\",\"guarantor_1_gender\":\"\",\"guarantor_1_marital_status\":\"\",\"guarantor_1_dental_insurance\":\"0\",\"guarantor_1_medical_insurance\":\"0\",\"guarantor_1_dental_deduction\":\"0.00\",\"guarantor_1_medicaid_number\":\"\",\"guarantor_1_bluecross_blueshield_number\":\"\",\"guarantor_1_zipcode\":\"32839\",\"guarantor_1_employer_id\":\"0\",\"guarantor_1_employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/0\"},\"guarantor_1_cell\":\"\",\"guarantor_1_email\":\"\",\"guarantor_1_ssn\":\"\",\"guarantor_2_firstname\":\"Test2\",\"guarantor_2_lastname\":\"Demo\",\"guarantor_2_middlename\":\"\",\"guarantor_2_address_line1\":\"\",\"guarantor_2_address_line2\":\"\",\"guarantor_2_city\":\"Orlando\",\"guarantor_2_state\":\"FL\",\"guarantor_2_phone\":\"\",\"guarantor_2_workphone\":\"\",\"guarantor_2_salutation\":\"\",\"guarantor_2_birthdate\":\"\",\"guarantor_2_gender\":\"\",\"guarantor_2_marital_status\":\"\",\"guarantor_2_dental_insurance\":\"0\",\"guarantor_2_medical_insurance\":\"0\",\"guarantor_2_dental_deduction\":\"0.00\",\"guarantor_2_medicaid_number\":\"\",\"guarantor_2_bluecross_blueshield_number\":\"\",\"guarantor_2_zipcode\":\"32839\",\"guarantor_2_employer_id\":\"0\",\"guarantor_2_employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/0\"},\"guarantor_2_cell\":\"\",\"guarantor_2_email\":\"\",\"guarantor_2_ssn\":\"\",\"guarantor_3_firstname\":\"\",\"guarantor_3_lastname\":\"\",\"guarantor_3_middlename\":\"\",\"guarantor_3_address_line1\":\"\",\"guarantor_3_address_line2\":\"\",\"guarantor_3_city\":\"\",\"guarantor_3_state\":\"\",\"guarantor_3_phone\":\"\",\"guarantor_3_workphone\":\"\",\"guarantor_3_salutation\":\"\",\"guarantor_3_birthdate\":\"\",\"guarantor_3_gender\":\"\",\"guarantor_3_marital_status\":\"\",\"guarantor_3_dental_insurance\":\"0\",\"guarantor_3_medical_insurance\":\"0\",\"guarantor_3_dental_deduction\":\"0.00\",\"guarantor_3_medicaid_number\":\"\",\"guarantor_3_bluecross_blueshield_number\":\"\",\"guarantor_3_zipcode\":\"\",\"guarantor_3_employer_id\":\"0\",\"guarantor_3_employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/0\"},\"guarantor_3_cell\":\"\",\"guarantor_3_email\":\"\",\"guarantor_3_ssn\":\"\",\"guarantor_4_firstname\":\"\",\"guarantor_4_lastname\":\"\",\"guarantor_4_middlename\":\"\",\"guarantor_4_address_line1\":\"\",\"guarantor_4_address_line2\":\"\",\"guarantor_4_city\":\"\",\"guarantor_4_state\":\"\",\"guarantor_4_phone\":\"\",\"guarantor_4_workphone\":\"\",\"guarantor_4_salutation\":\"\",\"guarantor_4_birthdate\":\"\",\"guarantor_4_gender\":\"\",\"guarantor_4_marital_status\":\"\",\"guarantor_4_dental_insurance\":\"0\",\"guarantor_4_medical_insurance\":\"0\",\"guarantor_4_dental_deduction\":\"0.00\",\"guarantor_4_medicaid_number\":\"\",\"guarantor_4_bluecross_blueshield_number\":\"\",\"guarantor_4_zipcode\":\"\",\"guarantor_4_employer_id\":\"0\",\"guarantor_4_employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/0\"},\"guarantor_4_cell\":\"\",\"guarantor_4_email\":\"\",\"guarantor_4_ssn\":\"\",\"provider_id\":\"1\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/1\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"created_date\":\"2017-04-20\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantor_accounts\\/355500\",\"guarantor_id\":\"355500\",\"guarantor_1_firstname\":\"Aswathy\",\"guarantor_1_lastname\":\"Kuttipishash\",\"guarantor_1_middlename\":\"\",\"guarantor_1_address_line1\":\"\",\"guarantor_1_address_line2\":\"\",\"guarantor_1_city\":\"Orlando\",\"guarantor_1_state\":\"FL\",\"guarantor_1_phone\":\"\",\"guarantor_1_workphone\":\"\",\"guarantor_1_salutation\":\"\",\"guarantor_1_birthdate\":\"\",\"guarantor_1_gender\":\"\",\"guarantor_1_marital_status\":\"\",\"guarantor_1_dental_insurance\":\"0\",\"guarantor_1_medical_insurance\":\"0\",\"guarantor_1_dental_deduction\":\"0.00\",\"guarantor_1_medicaid_number\":\"\",\"guarantor_1_bluecross_blueshield_number\":\"\",\"guarantor_1_zipcode\":\"32839\",\"guarantor_1_employer_id\":\"0\",\"guarantor_1_employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/0\"},\"guarantor_1_cell\":\"\",\"guarantor_1_email\":\"\",\"guarantor_1_ssn\":\"\",\"guarantor_2_firstname\":\"Kutty\",\"guarantor_2_lastname\":\"Kuttipishash\",\"guarantor_2_middlename\":\"\",\"guarantor_2_address_line1\":\"Avide Evideyo\",\"guarantor_2_address_line2\":\"\",\"guarantor_2_city\":\"Orlando\",\"guarantor_2_state\":\"FL\",\"guarantor_2_phone\":\"\",\"guarantor_2_workphone\":\"\",\"guarantor_2_salutation\":\"\",\"guarantor_2_birthdate\":\"\",\"guarantor_2_gender\":\"\",\"guarantor_2_marital_status\":\"\",\"guarantor_2_dental_insurance\":\"973\",\"guarantor_2_medical_insurance\":\"0\",\"guarantor_2_dental_deduction\":\"0.00\",\"guarantor_2_medicaid_number\":\"\",\"guarantor_2_bluecross_blueshield_number\":\"\",\"guarantor_2_zipcode\":\"32839\",\"guarantor_2_employer_id\":\"32\",\"guarantor_2_employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/32\"},\"guarantor_2_cell\":\"\",\"guarantor_2_email\":\"\",\"guarantor_2_ssn\":\"\",\"guarantor_3_firstname\":\"\",\"guarantor_3_lastname\":\"\",\"guarantor_3_middlename\":\"\",\"guarantor_3_address_line1\":\"\",\"guarantor_3_address_line2\":\"\",\"guarantor_3_city\":\"\",\"guarantor_3_state\":\"\",\"guarantor_3_phone\":\"\",\"guarantor_3_workphone\":\"\",\"guarantor_3_salutation\":\"\",\"guarantor_3_birthdate\":\"\",\"guarantor_3_gender\":\"\",\"guarantor_3_marital_status\":\"\",\"guarantor_3_dental_insurance\":\"0\",\"guarantor_3_medical_insurance\":\"0\",\"guarantor_3_dental_deduction\":\"0.00\",\"guarantor_3_medicaid_number\":\"\",\"guarantor_3_bluecross_blueshield_number\":\"\",\"guarantor_3_zipcode\":\"\",\"guarantor_3_employer_id\":\"0\",\"guarantor_3_employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/0\"},\"guarantor_3_cell\":\"\",\"guarantor_3_email\":\"\",\"guarantor_3_ssn\":\"\",\"guarantor_4_firstname\":\"\",\"guarantor_4_lastname\":\"\",\"guarantor_4_middlename\":\"\",\"guarantor_4_address_line1\":\"\",\"guarantor_4_address_line2\":\"\",\"guarantor_4_city\":\"\",\"guarantor_4_state\":\"\",\"guarantor_4_phone\":\"\",\"guarantor_4_workphone\":\"\",\"guarantor_4_salutation\":\"\",\"guarantor_4_birthdate\":\"\",\"guarantor_4_gender\":\"\",\"guarantor_4_marital_status\":\"\",\"guarantor_4_dental_insurance\":\"0\",\"guarantor_4_medical_insurance\":\"0\",\"guarantor_4_dental_deduction\":\"0.00\",\"guarantor_4_medicaid_number\":\"\",\"guarantor_4_bluecross_blueshield_number\":\"\",\"guarantor_4_zipcode\":\"\",\"guarantor_4_employer_id\":\"0\",\"guarantor_4_employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/0\"},\"guarantor_4_cell\":\"\",\"guarantor_4_email\":\"\",\"guarantor_4_ssn\":\"\",\"provider_id\":\"1\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/1\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"created_date\":\"2017-01-16\"}]}]\r\n"}],"_postman_id":"63b8b37b-1c08-4648-a5fc-96796f5b684a"},{"name":"guarantor_accounts using guarantor_id","id":"e9f8e1ca-e0c3-43e0-a27c-392f812fa9d8","request":{"method":"GET","header":[],"url":"{{url}}/guarantor_accounts/{guarantor_id}?request_key={{request_key}}","description":"

Get the guarantor_accounts information from practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
provider_id	Provider id as per practice management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
phone	Phone Number	No
workphone	Work Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
guarantor_id	Guarantor id as per practice management systems
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["guarantor_accounts","{guarantor_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"bd4de795-48da-4125-86a4-51822afd4430","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/guarantor_accounts/{guarantor_id}?request_key={{request_key}}","host":["{{url}}"],"path":["guarantor_accounts","{guarantor_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"3432","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:34:48 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"500\",\"total_count\":\"1\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantor_accounts\\/355600\",\"guarantor_id\":\"355600\",\"guarantor_1_firstname\":\"Test\",\"guarantor_1_lastname\":\"Demo\",\"guarantor_1_middlename\":\"\",\"guarantor_1_address_line1\":\"\",\"guarantor_1_address_line2\":\"\",\"guarantor_1_city\":\"Orlando\",\"guarantor_1_state\":\"FL\",\"guarantor_1_phone\":\"\",\"guarantor_1_workphone\":\"\",\"guarantor_1_salutation\":\"\",\"guarantor_1_birthdate\":\"\",\"guarantor_1_gender\":\"\",\"guarantor_1_marital_status\":\"\",\"guarantor_1_dental_insurance\":\"0\",\"guarantor_1_medical_insurance\":\"0\",\"guarantor_1_dental_deduction\":\"0.00\",\"guarantor_1_medicaid_number\":\"\",\"guarantor_1_bluecross_blueshield_number\":\"\",\"guarantor_1_zipcode\":\"32839\",\"guarantor_1_employer_id\":\"0\",\"guarantor_1_employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/0\"},\"guarantor_1_cell\":\"\",\"guarantor_1_email\":\"\",\"guarantor_1_ssn\":\"\",\"guarantor_2_firstname\":\"Test2\",\"guarantor_2_lastname\":\"Demo\",\"guarantor_2_middlename\":\"\",\"guarantor_2_address_line1\":\"\",\"guarantor_2_address_line2\":\"\",\"guarantor_2_city\":\"Orlando\",\"guarantor_2_state\":\"FL\",\"guarantor_2_phone\":\"\",\"guarantor_2_workphone\":\"\",\"guarantor_2_salutation\":\"\",\"guarantor_2_birthdate\":\"\",\"guarantor_2_gender\":\"\",\"guarantor_2_marital_status\":\"\",\"guarantor_2_dental_insurance\":\"0\",\"guarantor_2_medical_insurance\":\"0\",\"guarantor_2_dental_deduction\":\"0.00\",\"guarantor_2_medicaid_number\":\"\",\"guarantor_2_bluecross_blueshield_number\":\"\",\"guarantor_2_zipcode\":\"32839\",\"guarantor_2_employer_id\":\"0\",\"guarantor_2_employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/0\"},\"guarantor_2_cell\":\"\",\"guarantor_2_email\":\"\",\"guarantor_2_ssn\":\"\",\"guarantor_3_firstname\":\"\",\"guarantor_3_lastname\":\"\",\"guarantor_3_middlename\":\"\",\"guarantor_3_address_line1\":\"\",\"guarantor_3_address_line2\":\"\",\"guarantor_3_city\":\"\",\"guarantor_3_state\":\"\",\"guarantor_3_phone\":\"\",\"guarantor_3_workphone\":\"\",\"guarantor_3_salutation\":\"\",\"guarantor_3_birthdate\":\"\",\"guarantor_3_gender\":\"\",\"guarantor_3_marital_status\":\"\",\"guarantor_3_dental_insurance\":\"0\",\"guarantor_3_medical_insurance\":\"0\",\"guarantor_3_dental_deduction\":\"0.00\",\"guarantor_3_medicaid_number\":\"\",\"guarantor_3_bluecross_blueshield_number\":\"\",\"guarantor_3_zipcode\":\"\",\"guarantor_3_employer_id\":\"0\",\"guarantor_3_employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/0\"},\"guarantor_3_cell\":\"\",\"guarantor_3_email\":\"\",\"guarantor_3_ssn\":\"\",\"guarantor_4_firstname\":\"\",\"guarantor_4_lastname\":\"\",\"guarantor_4_middlename\":\"\",\"guarantor_4_address_line1\":\"\",\"guarantor_4_address_line2\":\"\",\"guarantor_4_city\":\"\",\"guarantor_4_state\":\"\",\"guarantor_4_phone\":\"\",\"guarantor_4_workphone\":\"\",\"guarantor_4_salutation\":\"\",\"guarantor_4_birthdate\":\"\",\"guarantor_4_gender\":\"\",\"guarantor_4_marital_status\":\"\",\"guarantor_4_dental_insurance\":\"0\",\"guarantor_4_medical_insurance\":\"0\",\"guarantor_4_dental_deduction\":\"0.00\",\"guarantor_4_medicaid_number\":\"\",\"guarantor_4_bluecross_blueshield_number\":\"\",\"guarantor_4_zipcode\":\"\",\"guarantor_4_employer_id\":\"0\",\"guarantor_4_employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/0\"},\"guarantor_4_cell\":\"\",\"guarantor_4_email\":\"\",\"guarantor_4_ssn\":\"\",\"provider_id\":\"1\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/1\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"created_date\":\"2017-04-20\"}]}]\r\n"}],"_postman_id":"e9f8e1ca-e0c3-43e0-a27c-392f812fa9d8"},{"name":"guarantor_patient_mapping","id":"67f067b0-bfa4-47cf-ab30-393ba58c9758","request":{"method":"GET","header":[],"url":"{{url}}/guarantor_patient_mapping?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
guarantor_id	Guarantor id as per practice management systems
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["guarantor_patient_mapping"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"b8085e3c-be1e-46a7-acb2-09a7936cd977","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/guarantor_patient_mapping?request_key={{request_key}}","host":["{{url}}"],"path":["guarantor_patient_mapping"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1593","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:39:27 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"5071\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantor_patient_mapping/6070\",\n \"guarantor_id\": \"6070\",\n \"patient_id\": \"6070\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/6070\"\n },\n \"firstname\": \"Ttedda\",\n \"middlename\": \"\",\n \"lastname\": \"Sqode\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1967-06-20\",\n \"employer_id\": \"1117\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"Peoria\",\n \"state\": \"IL\",\n \"zipcode\": \"61614\",\n \"phone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"guarantor_class\": \"\",\n \"email\": \"\",\n \"preferred_contact\": \"\",\n \"billing_type\": \"\",\n \"status\": \"A\",\n \"suspended_date\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/1117\"\n },\n \"country\": \"\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantor_patient_mapping/6068\",\n \"guarantor_id\": \"6068\",\n \"patient_id\": \"6068\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/6068\"\n },\n \"firstname\": \"Aastde\",\n \"middlename\": \"\",\n \"lastname\": \"Aqode\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1977-05-11\",\n \"employer_id\": \"0\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"Peoria\",\n \"state\": \"IL\",\n \"zipcode\": \"61614\",\n \"phone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"xxxxxxxxxx\",\n \"guarantor_class\": \"\",\n \"email\": \"\",\n \"preferred_contact\": \"\",\n \"billing_type\": \"\",\n \"status\": \"A\",\n \"suspended_date\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/0\"\n },\n \"country\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"67f067b0-bfa4-47cf-ab30-393ba58c9758"},{"name":"guarantor_patient_mapping by guarantor_id","id":"74bb5dbd-41fc-44b6-81e7-bb295f6db4b3","request":{"method":"GET","header":[],"url":"{{url}}/guarantor_patient_mapping/{guarantor_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
guarantor_id	Guarantor id as per practice management systems
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["guarantor_patient_mapping","{guarantor_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"315497dd-b402-49ed-8b8b-219842c7ef61","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/guarantor_patient_mapping/{guarantor_id}?request_key={{request_key}}","host":["{{url}}"],"path":["guarantor_patient_mapping","{guarantor_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"765","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:42:34 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantor_patient_mapping\\/6070\",\"guarantor_id\":\"6070\",\"patient_id\":\"6070\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6070\"},\"firstname\":\"Ttedda\",\"middlename\":\"\",\"lastname\":\"Sqode\",\"preferred_name\":\"\",\"salutation\":\"\",\"birthdate\":\"1967-06-20\",\"employer_id\":\"1117\",\"address_line1\":\"\",\"address_line2\":\"\",\"city\":\"Peoria\",\"state\":\"IL\",\"zipcode\":\"61614\",\"phone\":\"\",\"workphone\":\"\",\"cell\":\"\",\"guarantor_class\":\"\",\"email\":\"\",\"preferred_contact\":\"\",\"billing_type\":\"\",\"status\":\"A\",\"suspended_date\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/1117\"},\"country\":\"\"}\r\n"}],"_postman_id":"74bb5dbd-41fc-44b6-81e7-bb295f6db4b3"},{"name":"guarantors_v2","id":"78f71c15-fc90-4fb4-a9ab-f37bc31c7b16","request":{"method":"GET","header":[],"url":"{{url}}/guarantors_v2?request_key={{request_key}}","description":"

Guarantors_v2 API returns the guarantor information. It does not contain any patient relationship.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
cell	Cell Number	No
phone	Phone Number	No
workphone	Work Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
guarantor_id	Guarantor id as per practice management systems
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["guarantors_v2"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"2b2a524f-ee3e-445b-8ff8-196eeb383fe1","name":"sample response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/guarantors_v2?request_key={{request_key}}","host":["{{url}}"],"path":["guarantors_v2"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1486","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:51:29 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"7063\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors_v2/6070\",\n \"guarantor_id\": \"6070\",\n \"firstname\": \"Todd\",\n \"middlename\": \"\",\n \"lastname\": \"Schafer\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1967-06-20\",\n \"employer_id\": \"1117\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"Peoria\",\n \"state\": \"IL\",\n \"zipcode\": \"61614\",\n \"phone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"guarantor_class\": \"\",\n \"email\": \"\",\n \"preferred_contact\": \"\",\n \"billing_type\": \"\",\n \"status\": \"A\",\n \"suspended_date\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/1117\"\n },\n \"country\": \"\",\n \"client_type_code\": \"\",\n \"client_class\": \"\",\n \"ssn_on_file\": \"false\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors_v2/6068\",\n \"guarantor_id\": \"6068\",\n \"firstname\": \"Alex\",\n \"middlename\": \"\",\n \"lastname\": \"Alonso\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1977-05-11\",\n \"employer_id\": \"0\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"Peoria\",\n \"state\": \"IL\",\n \"zipcode\": \"61614\",\n \"phone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"xxxxxxxxxx\",\n \"guarantor_class\": \"\",\n \"email\": \"\",\n \"preferred_contact\": \"\",\n \"billing_type\": \"\",\n \"status\": \"A\",\n \"suspended_date\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/0\"\n },\n \"country\": \"\",\n \"client_type_code\": \"\",\n \"client_class\": \"\",\n \"ssn_on_file\": \"false\"\n }\n ]\n }\n]"}],"_postman_id":"78f71c15-fc90-4fb4-a9ab-f37bc31c7b16"},{"name":"guarantors_v2 by guarantor_id","id":"4a65b6bb-8f94-4c58-b9ce-23d65d68111e","request":{"method":"GET","header":[],"url":"{{url}}/guarantors_v2/{guarantor_id}?request_key={{request_key}}","description":"

Guarantors_v2 API returns the guarantor information. It does not contain any patient relationship.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
cell	Cell Number	No
phone	Phone Number	No
workphone	Work Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
guarantor_id	Guarantor id as per practice management systems
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["guarantors_v2","{guarantor_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"e97f175c-a352-457b-b652-09946bc43e6f","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/guarantors_v2/{guarantor_id}?request_key={{request_key}}","host":["{{url}}"],"path":["guarantors_v2","{guarantor_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"712","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 10:57:23 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors_v2\\/6070\",\"guarantor_id\":\"6070\",\"firstname\":\"Todd\",\"middlename\":\"\",\"lastname\":\"Schafer\",\"preferred_name\":\"\",\"salutation\":\"\",\"birthdate\":\"1967-06-20\",\"employer_id\":\"1117\",\"address_line1\":\"\",\"address_line2\":\"\",\"city\":\"Peoria\",\"state\":\"IL\",\"zipcode\":\"61614\",\"phone\":\"\",\"workphone\":\"\",\"cell\":\"\",\"guarantor_class\":\"\",\"email\":\"\",\"preferred_contact\":\"\",\"billing_type\":\"\",\"status\":\"A\",\"suspended_date\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/1117\"},\"country\":\"\",\"client_type_code\":\"\",\"client_class\":\"\",\"ssn_on_file\":\"false\"}\r\n"}],"_postman_id":"4a65b6bb-8f94-4c58-b9ce-23d65d68111e"}],"id":"f4399c83-e40f-4506-b980-9fce1d13220e","description":"

It contians all APIs related guarantors information

\n","_postman_id":"f4399c83-e40f-4506-b980-9fce1d13220e"},{"name":"Insurance","item":[{"name":"insurance_accounts_receivables","id":"839a582b-1681-4fe6-a1a0-d88b5e3aadd9","request":{"method":"GET","header":[],"url":"{{url}}/insurance_accounts_receivables?request_key={{request_key}}","description":"

Display patient's insurance account receivables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["insurance_accounts_receivables"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"d57f5317-a5bf-43af-86f0-237db8c99b58","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/insurance_accounts_receivables?request_key={{request_key}}","host":["{{url}}"],"path":["insurance_accounts_receivables"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1230","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:12:56 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"90\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_accounts_receivables\\/6066\",\"patient_id\":\"6066\",\"amount_less_than_30\":\"127.0000\",\"amount_between_30_60\":\"0.0000\",\"amount_between_60_90\":\"0.0000\",\"amount_greater_than_90\":\"0.0000\",\"estimated_amount_less_than_30\":\"22.4000\",\"estimated_amount_between_30_60\":\"0.0000\",\"estimated_amount_between_60_90\":\"0.0000\",\"estimated_amount_greater_than_90\":\"0.0000\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6066\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_accounts_receivables\\/6063\",\"patient_id\":\"6063\",\"amount_less_than_30\":\"335.0000\",\"amount_between_30_60\":\"0.0000\",\"amount_between_60_90\":\"0.0000\",\"amount_greater_than_90\":\"0.0000\",\"estimated_amount_less_than_30\":\"318.2500\",\"estimated_amount_between_30_60\":\"0.0000\",\"estimated_amount_between_60_90\":\"0.0000\",\"estimated_amount_greater_than_90\":\"0.0000\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6063\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"839a582b-1681-4fe6-a1a0-d88b5e3aadd9"},{"name":"insurance_accounts_receivables by patient_id","id":"546473bd-dd67-4121-a1eb-afc7b4bb9d3f","request":{"method":"GET","header":[],"url":"{{url}}/insurance_accounts_receivables/{patient_id}?request_key={{request_key}}","description":"

Display patient's insurance account receivables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["insurance_accounts_receivables","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"33904a69-888d-4510-a4e3-a75837243e9d","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/insurance_accounts_receivables/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["insurance_accounts_receivables","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"586","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:15:44 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_accounts_receivables\\/6066\",\"patient_id\":\"6066\",\"amount_less_than_30\":\"127.0000\",\"amount_between_30_60\":\"0.0000\",\"amount_between_60_90\":\"0.0000\",\"amount_greater_than_90\":\"0.0000\",\"estimated_amount_less_than_30\":\"22.4000\",\"estimated_amount_between_30_60\":\"0.0000\",\"estimated_amount_between_60_90\":\"0.0000\",\"estimated_amount_greater_than_90\":\"0.0000\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6066\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"546473bd-dd67-4121-a1eb-afc7b4bb9d3f"},{"name":"insurance_companies","id":"4ef66f3e-038c-41f9-aaff-6f597ffddaf5","request":{"method":"GET","header":[],"url":"{{url}}/insurance_companies?request_key={{request_key}}","description":"

'insurance_companies' API will display insurance company id, carrier and group plan information.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
insurance_company_name	Insurance Company Name
insurance_company_id	Insurance Company ID

","urlObject":{"path":["insurance_companies"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"c8c3636d-3fd0-4834-8710-09cab8d7914c","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/insurance_companies?request_key={{request_key}}","host":["{{url}}"],"path":["insurance_companies"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"2245","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:18:26 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"3092\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies/1118\",\n \"insurance_company_id\": \"1118\",\n \"insurance_company_name\": \"Test Company1\",\n \"group_plan_name\": \"\",\n \"maximum_yearly_benefit\": \"1500.0000\",\n \"address_line1\": \"P.O.Box 10101\",\n \"address_line2\": \"\",\n \"city\": \"Lancaster\",\n \"state\": \"PA\",\n \"zipcode\": \"17605\",\n \"phone\": \"xxxxxxxxxx\",\n \"payer_id\": \"CX092\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"group_plan_number\": \"Amerc01391909\",\n \"renew_month\": \"\",\n \"employer_id\": \"1118_466\",\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/1118_466\"\n },\n \"country\": \"\",\n \"fee_no\": \"default\",\n \"maximum_family_benefit\": \"0.0000\",\n \"insurance_type\": \"\",\n \"plan_type\": \"\",\n \"sub_type\": \"\",\n \"is_maximum_coverage\": \"\",\n \"maximum_coverage_amount\": \"\",\n \"family_deductible_limit\": \"\",\n \"individual_deductible_limit\": \"\",\n \"individual_ortho_maximum_limit\": \"\",\n \"charge_per_visit\": \"\",\n \"notes\": \"\",\n \"insurance_plan_status\": \"\",\n \"mail_to_insurance_company_id\": \"\",\n \"pre_authorization_mail_to_insurance_company_id\": \"\",\n \"eligibility\": \"\",\n \"fax\": \"\",\n \"default_employer\": \"\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies/1119\",\n \"insurance_company_id\": \"1119\",\n \"insurance_company_name\": \"Test Company2\",\n \"group_plan_name\": \"\",\n \"maximum_yearly_benefit\": \"1500.0000\",\n \"address_line1\": \"P.O.Box 10188\",\n \"address_line2\": \"\",\n \"city\": \"Lancaster\",\n \"state\": \"PA\",\n \"zipcode\": \"17605\",\n \"phone\": \"xxxxxxxxxx\",\n \"payer_id\": \"CX092\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"group_plan_number\": \"Amerc013919099999999\",\n \"renew_month\": \"\",\n \"employer_id\": \"466\",\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/466\"\n },\n \"country\": \"\",\n \"fee_no\": \"default\",\n \"maximum_family_benefit\": \"0.0000\",\n \"insurance_type\": \"\",\n \"plan_type\": \"\",\n \"sub_type\": \"\",\n \"is_maximum_coverage\": \"\",\n \"maximum_coverage_amount\": \"\",\n \"family_deductible_limit\": \"\",\n \"individual_deductible_limit\": \"\",\n \"individual_ortho_maximum_limit\": \"\",\n \"charge_per_visit\": \"\",\n \"notes\": \"\",\n \"insurance_plan_status\": \"\",\n \"mail_to_insurance_company_id\": \"\",\n \"pre_authorization_mail_to_insurance_company_id\": \"\",\n \"eligibility\": \"\",\n \"fax\": \"\",\n \"default_employer\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"4ef66f3e-038c-41f9-aaff-6f597ffddaf5"},{"name":"insurance_companies by insurance_company_id","id":"32d00afc-76ca-479e-8b38-cb27021eb317","request":{"method":"GET","header":[],"url":"{{url}}/insurance_companies/{insurance_company_id}?request_key={{request_key}}","description":"

'insurance_companies' API will display carrier and group plan information as per the insurance company id.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
insurance_company_name	Insurance Company Name
insurance_company_id	Insurance Company ID

","urlObject":{"path":["insurance_companies","{insurance_company_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"b514403b-16eb-42f3-9424-11c2160f086e","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/insurance_companies/{insurance_company_id}?request_key={{request_key}}","host":["{{url}}"],"path":["insurance_companies","{insurance_company_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1098","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:20:13 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies/1118\",\n \"insurance_company_id\": \"1118\",\n \"insurance_company_name\": \"Test Company1\",\n \"group_plan_name\": \"\",\n \"maximum_yearly_benefit\": \"1500.0000\",\n \"address_line1\": \"P.O.Box 10188\",\n \"address_line2\": \"\",\n \"city\": \"Lancaster\",\n \"state\": \"PA\",\n \"zipcode\": \"17605\",\n \"phone\": \"xxxxxxxxxx\",\n \"payer_id\": \"CX092\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"group_plan_number\": \"Amerc0139190999\",\n \"renew_month\": \"\",\n \"employer_id\": \"1118_466\",\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/1118_466\"\n },\n \"country\": \"\",\n \"fee_no\": \"default\",\n \"maximum_family_benefit\": \"0.0000\",\n \"insurance_type\": \"\",\n \"plan_type\": \"\",\n \"sub_type\": \"\",\n \"is_maximum_coverage\": \"\",\n \"maximum_coverage_amount\": \"\",\n \"family_deductible_limit\": \"\",\n \"individual_deductible_limit\": \"\",\n \"individual_ortho_maximum_limit\": \"\",\n \"charge_per_visit\": \"\",\n \"notes\": \"\",\n \"insurance_plan_status\": \"\",\n \"mail_to_insurance_company_id\": \"\",\n \"pre_authorization_mail_to_insurance_company_id\": \"\",\n \"eligibility\": \"\",\n \"fax\": \"\",\n \"default_employer\": \"\"\n}"}],"_postman_id":"32d00afc-76ca-479e-8b38-cb27021eb317"},{"name":"insurance_plan_coverage","id":"43900492-9209-45bd-bb75-171b5f2f6efd","request":{"method":"GET","header":[],"url":"{{url}}/insurance_plan_coverage?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
insurance_company_id	Insurance Company ID

","urlObject":{"path":["insurance_plan_coverage"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"bdfb9d70-2f11-4c66-b13d-928afc2703ff","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/insurance_plan_coverage?request_key={{request_key}}","host":["{{url}}"],"path":["insurance_plan_coverage"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"995","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:22:39 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"753757\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_plan_coverage\\/999\",\"insurance_company_id\":\"999\",\"insurance_company\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_companies\\/999\"},\"procedure_code_from\":\"D2990\",\"co_pay\":\"0.0000\",\"procedure_code_to\":\"\",\"percentage_covered\":\"80.00\",\"category\":\"RESTORATIVE\",\"deductible\":\"Y\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"is_deductible\":\"\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_plan_coverage\\/999\",\"insurance_company_id\":\"999\",\"insurance_company\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_companies\\/999\"},\"procedure_code_from\":\"SEDFL\",\"co_pay\":\"0.0000\",\"procedure_code_to\":\"\",\"percentage_covered\":\"80.00\",\"category\":\"RESTORATIVE\",\"deductible\":\"Y\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"is_deductible\":\"\"}]}]\r\n"}],"_postman_id":"43900492-9209-45bd-bb75-171b5f2f6efd"},{"name":"insurance_plan_coverage by insurance_company_id","id":"9cdc7687-f058-49bd-8c35-6af0c9952527","request":{"method":"GET","header":[],"url":"{{url}}/insurance_plan_coverage/{insurance_company_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
insurance_company_id	Insurance Company ID

","urlObject":{"path":["insurance_plan_coverage","{insurance_company_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"198cd7cd-0d75-49a9-bcac-90d2fd830952","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/insurance_plan_coverage/{insurance_company_id}?request_key={{request_key}}","host":["{{url}}"],"path":["insurance_plan_coverage","{insurance_company_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"540","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:24:56 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"1\",\"total_count\":\"731\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_plan_coverage\\/999\",\"insurance_company_id\":\"999\",\"insurance_company\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_companies\\/999\"},\"procedure_code_from\":\"\\/F\",\"co_pay\":\"0.0000\",\"procedure_code_to\":\"\",\"percentage_covered\":\"50.00\",\"category\":\"ADJUNCTIVE GENERAL SERVICES\",\"deductible\":\"Y\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"is_deductible\":\"\"}]}]\r\n"}],"_postman_id":"9cdc7687-f058-49bd-8c35-6af0c9952527"},{"name":"payors","id":"d9c5d8df-8aac-4685-94bf-01f16a30befc","request":{"method":"GET","header":[],"url":"{{url}}/payors?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
insurance_company_name	Insurance Company Name
insurance_company_id	Insurance Company ID

","urlObject":{"path":["payors"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"64bc59e6-500f-4913-ab22-5cd2f296389c","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/payors?request_key={{request_key}}","host":["{{url}}"],"path":["payors"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"894","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:00:47 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"1350\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/payors/1118_466\",\n \"insurance_company_id\": \"1118_466\",\n \"insurance_company_name\": \"Test Company1\",\n \"address_line1\": \"P.O.Box 10188\",\n \"address_line2\": \"\",\n \"city\": \"Lancaster\",\n \"state\": \"PA\",\n \"zipcode\": \"17605\",\n \"phone\": \"\",\n \"fax\": \"\",\n \"email\": \"\",\n \"payor_id\": \"CX092\",\n \"payor_type\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/payors/1117_38\",\n \"insurance_company_id\": \"1117_38\",\n \"insurance_company_name\": \"Test Company2\",\n \"address_line1\": \"P.O. Box 5402\",\n \"address_line2\": \"\",\n \"city\": \"Lisle\",\n \"state\": \"IL\",\n \"zipcode\": \"60532\",\n \"phone\": \"\",\n \"fax\": \"\",\n \"email\": \"\",\n \"payor_id\": \"05030\",\n \"payor_type\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n }\n ]\n }\n]"}],"_postman_id":"d9c5d8df-8aac-4685-94bf-01f16a30befc"},{"name":"payors by insurance_company_id","id":"99eda3e2-9c61-4fea-9cdf-7250f57c1c0c","request":{"method":"GET","header":[],"url":"{{url}}/payors/{insurance_company_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
insurance_company_name	Insurance Company Name
insurance_company_id	Insurance Company ID

","urlObject":{"path":["payors","{insurance_company_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"20d0c650-de75-48df-88bc-bfd94a69d9d0","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/payors/{insurance_company_id}?request_key={{request_key}}","host":["{{url}}"],"path":["payors","{insurance_company_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"485","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:04:16 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"500\",\n \"total_count\": \"1\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/payors/1118_466\",\n \"insurance_company_id\": \"1118_466\",\n \"insurance_company_name\": \"Test Company1\",\n \"address_line1\": \"P.O.Box 10188\",\n \"address_line2\": \"\",\n \"city\": \"Lancaster\",\n \"state\": \"PA\",\n \"zipcode\": \"17605\",\n \"phone\": \"\",\n \"fax\": \"\",\n \"email\": \"\",\n \"payor_id\": \"CX092\",\n \"payor_type\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n }\n ]\n }\n]"}],"_postman_id":"99eda3e2-9c61-4fea-9cdf-7250f57c1c0c"},{"name":"subscribers","id":"e13714d4-faa4-420a-a956-6e55f2d71034","request":{"method":"GET","header":[],"url":"{{url}}/subscribers?request_key={{request_key}}","description":"

First, it may refer to the person or organization that pays for health insurance premiums; Secondivy, it may refer to the person whose employment makes him or her eligible for group health insurance benefits.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["subscribers"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"af279ec1-004e-4f78-817d-9efb87eae15b","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/subscribers?request_key={{request_key}}","host":["{{url}}"],"path":["subscribers"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"2073","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:45:31 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"2779\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/subscribers/99801\",\n \"patient_id\": \"99801\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/99801\"\n },\n \"birthdate\": \"1951-12-16\",\n \"subscriber_id\": \"013381305\",\n \"firstname\": \"Doaaa\",\n \"middlename\": \"\",\n \"lastname\": \"siaaa\",\n \"salutation\": \"Ms.\",\n \"gender\": \"F\",\n \"address_line1\": \"address 1\",\n \"address_line2\": \"\",\n \"employer_name\": \"Town emp\",\n \"city\": \"Orlando\",\n \"state\": \"FL\",\n \"zipcode\": \"32821\",\n \"type\": \"Dental_Primary\",\n \"insurance_company_id\": \"448\",\n \"insurance_company\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies/448\"\n },\n \"patient_relation\": \"Self\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"identification_type\": \"Guar_SSN\",\n \"individual_used\": \"0.0000\",\n \"individual_used_treatment_plan\": \"0.0000\",\n \"individual_deductible_remaining\": \"25.0000\",\n \"ortho_used\": \"0.0000\",\n \"ortho_used_treatment_plan\": \"0.0000\",\n \"insurance_effective_date\": \"2007-07-01\",\n \"family_deductible_reamining\": \"50.0000\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/subscribers/99601\",\n \"patient_id\": \"99601\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/99601\"\n },\n \"birthdate\": \"1987-06-06\",\n \"subscriber_id\": \"120602994\",\n \"firstname\": \"Anwen\",\n \"middlename\": \"\",\n \"lastname\": \"Frafi\",\n \"salutation\": \"\",\n \"gender\": \"M\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"employer_name\": \"Test emp\",\n \"city\": \"Orlando\",\n \"state\": \"FL\",\n \"zipcode\": \"32839\",\n \"type\": \"Dental_Primary\",\n \"insurance_company_id\": \"447\",\n \"insurance_company\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies/447\"\n },\n \"patient_relation\": \"Child\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"identification_type\": \"Guar_SSN\",\n \"individual_used\": \"0.0000\",\n \"individual_used_treatment_plan\": \"0.0000\",\n \"individual_deductible_remaining\": \"25.0000\",\n \"ortho_used\": \"0.0000\",\n \"ortho_used_treatment_plan\": \"0.0000\",\n \"insurance_effective_date\": \"2008-01-01\",\n \"family_deductible_reamining\": \"50.0000\"\n }\n ]\n }\n]"}],"_postman_id":"e13714d4-faa4-420a-a956-6e55f2d71034"},{"name":"subscribers by patient_id","id":"5615a836-015c-48ce-ba74-3c104c3d2457","request":{"method":"GET","header":[],"url":"{{url}}/subscribers/{patient_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["subscribers","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"e02ae67d-d284-46f9-9b04-3fff2e975988","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/subscribers/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["subscribers","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1011","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:47:10 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/subscribers/99801\",\n \"patient_id\": \"99801\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/99801\"\n },\n \"birthdate\": \"1951-12-16\",\n \"subscriber_id\": \"013381305\",\n \"firstname\": \"Fname\",\n \"middlename\": \"\",\n \"lastname\": \"Lname\",\n \"salutation\": \"Ms.\",\n \"gender\": \"F\",\n \"address_line1\": \"101 Donhi Court\",\n \"address_line2\": \"\",\n \"employer_name\": \"Tony Test\",\n \"city\": \"Orlando\",\n \"state\": \"FL\",\n \"zipcode\": \"32821\",\n \"type\": \"Dental_Primary\",\n \"insurance_company_id\": \"448\",\n \"insurance_company\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies/448\"\n },\n \"patient_relation\": \"Self\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"identification_type\": \"Guar_SSN\",\n \"individual_used\": \"0.0000\",\n \"individual_used_treatment_plan\": \"0.0000\",\n \"individual_deductible_remaining\": \"25.0000\",\n \"ortho_used\": \"0.0000\",\n \"ortho_used_treatment_plan\": \"0.0000\",\n \"insurance_effective_date\": \"2007-07-01\",\n \"family_deductible_reamining\": \"50.0000\"\n}"}],"_postman_id":"5615a836-015c-48ce-ba74-3c104c3d2457"},{"name":"insurance_estimate ","id":"60f37dd5-c4c0-46d4-86fa-d9b476d7d4ec","request":{"method":"GET","header":[],"url":"https://api.sikkasoft.com/v2/insurance_estimate?request_key={{request_key}}","description":"

\"Insurance estimate\" API will return the collection of all insurance estimate

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
guarantor_id	Guarantor id as per practice management systems
icm_type	ICM type

","urlObject":{"protocol":"https","path":["v2","insurance_estimate"],"host":["api","sikkasoft","com"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"ac76dda9-be96-43f1-802b-5f494ed46fc1","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sikkasoft.com/v2/insurance_estimate?request_key={{request_key}}","protocol":"https","host":["api","sikkasoft","com"],"path":["v2","insurance_estimate"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Content-Encoding","key":"Content-Encoding","value":"gzip","description":""},{"name":"Content-Length","key":"Content-Length","value":"322","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 19 Jun 2017 05:32:42 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"Vary","key":"Vary","value":"Accept-Encoding","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"3241\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_estimate\\/355600\",\"guarantor_id\":\"355600\",\"icm_type\":\"2\",\"account_codes\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_estimate\\/355500\",\"guarantor_id\":\"355500\",\"icm_type\":\"2\",\"account_codes\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"60f37dd5-c4c0-46d4-86fa-d9b476d7d4ec"},{"name":"insurance_estimate by guarantor_id","id":"955c49cc-cc1a-426d-9181-09dbbe99130f","request":{"method":"GET","header":[],"url":"https://api.sikkasoft.com/v2/insurance_estimate/{guarantor_id}?request_key={{request_key}}","description":"

Get the information of insurance estimate as per the guarantor id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
guarantor_id	Guarantor id as per practice management systems
icm_type	ICM type

","urlObject":{"protocol":"https","path":["v2","insurance_estimate","{guarantor_id}"],"host":["api","sikkasoft","com"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"7804d7fa-d66e-4a6e-a6f3-97a19e5d99c2","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sikkasoft.com/v2/insurance_estimate/{guarantor_id}?request_key={{request_key}}","protocol":"https","host":["api","sikkasoft","com"],"path":["v2","insurance_estimate","{guarantor_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Content-Encoding","key":"Content-Encoding","value":"gzip","description":""},{"name":"Content-Length","key":"Content-Length","value":"304","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 19 Jun 2017 05:53:02 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"Vary","key":"Vary","value":"Accept-Encoding","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"500\",\"total_count\":\"1\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_estimate\\/355600\",\"guarantor_id\":\"355600\",\"icm_type\":\"2\",\"account_codes\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"955c49cc-cc1a-426d-9181-09dbbe99130f"},{"name":"insurance_company_details","id":"c8878982-2da8-4414-a9c5-55670a7decda","request":{"method":"GET","header":[],"url":"{{url}}/insurance_company_details?request_key={{request_key}}","description":"

Get the list of all insurance companies exist in practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
insurance_company_name	Insurance Company Name
insurance_company_id	Insurance Company ID

","urlObject":{"path":["insurance_company_details"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"e1ed4133-cddd-4988-90b2-bbe57f6ae393","name":"sample1","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/insurance_company_details?request_key={{request_key}}","host":["{{url}}"],"path":["insurance_company_details"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[{\r\n\t\"offset\": \"0\",\r\n\t\"limit\": \"1\",\r\n\t\"total_count\": \"24\",\r\n\t\"items\": [{\r\n\t\t\"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_company_details/24\",\r\n\t\t\"insurance_company_id\": \"24\",\r\n\t\t\"insurance_company_name\": \"Axar Ins Lt.\",\r\n\t\t\"address_line1\": \"201 Sikka A.\",\r\n\t\t\"address_line2\": \"\",\r\n\t\t\"beeper\": \"\",\r\n\t\t\"cell\": \"xxxxxxxxxx\",\r\n\t\t\"city\": \"Phoenix\",\r\n\t\t\"contact\": \"\",\r\n\t\t\"default_plan\": \"0\",\r\n\t\t\"email1\": \"satyen.pandya@sikkasoftware.com\",\r\n\t\t\"email2\": \"\",\r\n\t\t\"era_capable\": \"Yes\",\r\n\t\t\"ext1\": \"\",\r\n\t\t\"ext2\": \"\",\r\n\t\t\"ext3\": \"\",\r\n\t\t\"fax1\": \"\",\r\n\t\t\"fax2\": \"\",\r\n\t\t\"notes\": \"\",\r\n\t\t\"payer_id\": \"93200\",\r\n\t\t\"payer_type\": \"BCBS\",\r\n\t\t\"phone1\": \"xxxxxxxxxx\",\r\n\t\t\"phone2\": \"\",\r\n\t\t\"phone3\": \"\",\r\n\t\t\"practice_id\": \"1\",\r\n\t\t\"provider_practice_id\": \"0\",\r\n\t\t\"state\": \"AZ\",\r\n\t\t\"trojan_id\": \"\",\r\n\t\t\"web_link\": \"0\",\r\n\t\t\"zipcode\": \"29389\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://api.sikkasoft.com/v2/practices/1\"\r\n\t\t}\r\n\t}]\r\n}]"}],"_postman_id":"c8878982-2da8-4414-a9c5-55670a7decda"},{"name":"insurance_company_details by insurance_company_id","id":"5790c8ce-5fce-43ad-b45e-6b9a81f0af2b","request":{"method":"GET","header":[],"url":"{{url}}/insurance_company_details/{insurance_company_id}?request_key={{request_key}}","description":"

'insurance_company_details' API will display carrier and group plan information as per the insurance company id.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
insurance_company_name	Insurance Company Name
insurance_company_id	Insurance Company ID

","urlObject":{"path":["insurance_company_details","{insurance_company_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"997e7c9a-73e3-42fd-98e0-2ac17c0cff8b","name":"sample","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/insurance_company_details/{insurance_company_id}?request_key={{request_key}}","host":["{{url}}"],"path":["insurance_company_details","{insurance_company_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[{\r\n\t\"offset\": \"0\",\r\n\t\"limit\": \"1\",\r\n\t\"total_count\": \"24\",\r\n\t\"items\": [{\r\n\t\t\"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_company_details/24\",\r\n\t\t\"insurance_company_id\": \"24\",\r\n\t\t\"insurance_company_name\": \"Axar Ins Lt.\",\r\n\t\t\"address_line1\": \"201 Sikka A.\",\r\n\t\t\"address_line2\": \"\",\r\n\t\t\"beeper\": \"\",\r\n\t\t\"cell\": \"xxxxxxxxxx\",\r\n\t\t\"city\": \"Phoenix\",\r\n\t\t\"contact\": \"\",\r\n\t\t\"default_plan\": \"0\",\r\n\t\t\"email1\": \"satyen.pandya@sikkasoftware.com\",\r\n\t\t\"email2\": \"\",\r\n\t\t\"era_capable\": \"Yes\",\r\n\t\t\"ext1\": \"\",\r\n\t\t\"ext2\": \"\",\r\n\t\t\"ext3\": \"\",\r\n\t\t\"fax1\": \"\",\r\n\t\t\"fax2\": \"\",\r\n\t\t\"notes\": \"\",\r\n\t\t\"payer_id\": \"93200\",\r\n\t\t\"payer_type\": \"BCBS\",\r\n\t\t\"phone1\": \"xxxxxxxxxx\",\r\n\t\t\"phone2\": \"\",\r\n\t\t\"phone3\": \"\",\r\n\t\t\"practice_id\": \"1\",\r\n\t\t\"provider_practice_id\": \"0\",\r\n\t\t\"state\": \"AZ\",\r\n\t\t\"trojan_id\": \"\",\r\n\t\t\"web_link\": \"0\",\r\n\t\t\"zipcode\": \"29389\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://api.sikkasoft.com/v2/practices/1\"\r\n\t\t}\r\n\t}]\r\n}]"}],"_postman_id":"5790c8ce-5fce-43ad-b45e-6b9a81f0af2b"}],"id":"dc68aa40-a859-43f2-9b4a-88ac8eccc1f6","description":"

It contains all APIs related with insurance information.

\n","_postman_id":"dc68aa40-a859-43f2-9b4a-88ac8eccc1f6"},{"name":"Lab","item":[{"name":"lab_panels","id":"e42df891-f9c4-4fd3-a1ef-aae730fe1864","request":{"method":"GET","header":[],"url":"{{url}}/lab_panels?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
procedure_code_id	Procedure code id is same as procedure code.	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
lab_panel_id	Lab Panel ID

","urlObject":{"path":["lab_panels"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"85bb2dd3-6246-4c69-ac3a-a2469ecf7420","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/lab_panels?request_key={{request_key}}","host":["{{url}}"],"path":["lab_panels"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1458","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:30:56 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"5998\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/lab_panels\\/2147061644\",\"lab_panel_id\":\"2147061644\",\"patient_id\":\"3728-A\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/3728-A\"},\"guarantor_id\":\"3728\",\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/3728\"},\"procedure_code_id\":\"\",\"procedure_code_description\":\"OP + GIARDIA AG ELISA\",\"lab_name\":\"IDEXX LabREXX\",\"provider_id\":\"1\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/1\"},\"status\":\"Final\",\"comments\":\"\",\"create_date\":\"2015-06-30\",\"modified_date\":\"\",\"description\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/lab_panels\\/2146878109\",\"lab_panel_id\":\"2146878109\",\"patient_id\":\"1695-A\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/1695-A\"},\"guarantor_id\":\"1695\",\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/1695\"},\"procedure_code_id\":\"\",\"procedure_code_description\":\"FECAL FLOTATION\",\"lab_name\":\"\",\"provider_id\":\"4\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/4\"},\"status\":\"Final\",\"comments\":\"\",\"create_date\":\"2014-12-10\",\"modified_date\":\"\",\"description\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"e42df891-f9c4-4fd3-a1ef-aae730fe1864"},{"name":"lab_panels by lab_panel_id","id":"1ed04aaf-861f-4447-85f2-f97dfa0274e3","request":{"method":"GET","header":[],"url":"{{url}}/lab_panels/{lab_panel_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
procedure_code_id	Procedure code id is same as procedure code.	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
lab_panel_id	Lab Panel ID

","urlObject":{"path":["lab_panels","{lab_panel_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"99ed09ee-5222-471e-9233-8b68036d702a","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/lab_panels/{lab_panel_id}?request_key={{request_key}}","host":["{{url}}"],"path":["lab_panels","{lab_panel_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"709","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:33:37 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/lab_panels\\/2147061644\",\"lab_panel_id\":\"2147061644\",\"patient_id\":\"3728-A\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/3728-A\"},\"guarantor_id\":\"3728\",\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/3728\"},\"procedure_code_id\":\"\",\"procedure_code_description\":\"OP + GIARDIA AG ELISA\",\"lab_name\":\"IDEXX LabREXX\",\"provider_id\":\"1\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/1\"},\"status\":\"Final\",\"comments\":\"\",\"create_date\":\"2015-06-30\",\"modified_date\":\"\",\"description\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"1ed04aaf-861f-4447-85f2-f97dfa0274e3"},{"name":"lab_results","id":"5b416907-81fa-4b61-a94d-c512664dd722","request":{"method":"GET","header":[],"url":"{{url}}/lab_results?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
lab_panel_id	Lab Panel ID

","urlObject":{"path":["lab_results"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"f8c719c3-e5ff-44a4-a2d1-e818a372b6f4","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/lab_results?request_key={{request_key}}","host":["{{url}}"],"path":["lab_results"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1221","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:36:24 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"172316\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/lab_results\\/2147061644\",\"lab_panel_id\":\"2147061644\",\"lab_panel\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/lab_panels\\/2147061644\"},\"result_date\":\"2015-06-30\",\"test_name\":\"OVA & PARASITES\",\"measure_unit\":\"\",\"result\":\"No parasite found\",\"result_type\":\"\",\"critical_low\":\"\",\"critical_high\":\"\",\"reference_low\":\"\",\"reference_high\":\"\",\"reference_range\":\"\",\"comments\":\"\",\"lab_machine_name\":\"\",\"lab_machine_type\":\"\",\"lab_result_name\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/lab_results\\/2147061644\",\"lab_panel_id\":\"2147061644\",\"lab_panel\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/lab_panels\\/2147061644\"},\"result_date\":\"2015-06-30\",\"test_name\":\"Accession #\",\"measure_unit\":\"\",\"result\":\"8881402\",\"result_type\":\"\",\"critical_low\":\"\",\"critical_high\":\"\",\"reference_low\":\"\",\"reference_high\":\"\",\"reference_range\":\"\",\"comments\":\"\",\"lab_machine_name\":\"\",\"lab_machine_type\":\"\",\"lab_result_name\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"5b416907-81fa-4b61-a94d-c512664dd722"},{"name":"lab_results by lab_panel_id","id":"45c7f990-4025-4a96-97b3-7ea4ce3b022c","request":{"method":"GET","header":[],"url":"{{url}}/lab_results/{lab_panel_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
lab_panel_id	Lab Panel ID

","urlObject":{"path":["lab_results","{lab_panel_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"95a68bc0-f0b6-4dea-a1f9-0f49904f05f4","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/lab_results/{lab_panel_id}?request_key={{request_key}}","host":["{{url}}"],"path":["lab_results","{lab_panel_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"587","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:38:18 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/lab_results\\/2147061644\",\"lab_panel_id\":\"2147061644\",\"lab_panel\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/lab_panels\\/2147061644\"},\"result_date\":\"2015-06-30\",\"test_name\":\"OVA & PARASITES\",\"measure_unit\":\"\",\"result\":\"No parasite found\",\"result_type\":\"\",\"critical_low\":\"\",\"critical_high\":\"\",\"reference_low\":\"\",\"reference_high\":\"\",\"reference_range\":\"\",\"comments\":\"\",\"lab_machine_name\":\"\",\"lab_machine_type\":\"\",\"lab_result_name\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"45c7f990-4025-4a96-97b3-7ea4ce3b022c"}],"id":"220f08ec-fd27-4a99-99e4-f9f66844f566","description":"

It contains all APIs related with lab informaion in practice

\n","_postman_id":"220f08ec-fd27-4a99-99e4-f9f66844f566"},{"name":"Patients","item":[{"name":"patients","id":"f085d0d3-aca5-4c98-9c6c-ad4c4841c254","request":{"method":"GET","header":[],"url":"{{url}}/patients?request_key={{request_key}}","description":"

Get the full list of all patient collections.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
guarantor_id	Guarantor id as per practice management systems	No
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
last_visit	Last Visit	No
cell	Cell Number	No
search	Search patient by firstname , lastname , email , middlename, city, state, zipcode, homephone, workphone, cell	No
status	Status of patient	No
phone	Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["patients"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"813f0034-dcaa-4d74-a029-2924716ea787","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patients?request_key={{request_key}}","host":["{{url}}"],"path":["patients"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"3816","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 10:06:53 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"5071\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/6071\",\n \"patient_id\": \"6071\",\n \"guarantor_id\": \"5865\",\n \"firstname\": \"Wastde\",\n \"middlename\": \"\",\n \"lastname\": \"Kmade\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1926-12-26\",\n \"status\": \"Active\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"Male\",\n \"address_line1\": \"260ugdt\",\n \"address_line2\": \"\",\n \"city\": \"Peoria\",\n \"state\": \"IL\",\n \"zipcode\": \"61604\",\n \"homephone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"email\": \"\",\n \"employer_id\": \"1082_282\",\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/1082_282\"\n },\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"provider_id\": \"DR\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/DR\"\n },\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments?patient_id=6071\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/5865\"\n },\n \"primary_insurance_company_id\": \"1082\",\n \"primary_insurance_company\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies/1082\"\n },\n \"secondary_insurance_company_id\": \"\",\n \"primary_relationship\": \"Self\",\n \"country\": \"\",\n \"primary_medical_insurance\": \"\",\n \"primary_medical_insurance_id\": \"\",\n \"primary_medical_relationship\": \"\",\n \"primary_medical_subscriber_id\": \"\",\n \"secondary_medical_insurance\": \"\",\n \"secondary_medical_insurance_id\": \"\",\n \"secondary_medical_relationship\": \"\",\n \"secondary_medical_subscriber_id\": \"\",\n \"secondary_relationship\": \"\",\n \"subscriber_id\": \"\",\n \"patient_account_id\": \"\",\n \"other_referral\": \"\",\n \"patient_referral\": \"\",\n \"referred_out\": \"\",\n \"referred_by_provider_id\": \"\",\n \"referred_by_patient_id\": \"\",\n \"image\": \"\",\n \"thumb_image\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"Mastde\",\n \"guarantor_last_name\": \"Kugdt\",\n \"created_date\": \"2016-04-20\",\n \"preferred_contact\": \"\",\n \"hygienist\": \"LW\",\n \"patient_codes\": \"\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/6070\",\n \"patient_id\": \"6070\",\n \"guarantor_id\": \"6070\",\n \"firstname\": \"Tastde\",\n \"middlename\": \"\",\n \"lastname\": \"Smade\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1967-06-20\",\n \"status\": \"Active\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"Male\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"Peoria\",\n \"state\": \"IL\",\n \"zipcode\": \"61614\",\n \"homephone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"email\": \"\",\n \"employer_id\": \"1117_38\",\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/1117_38\"\n },\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"provider_id\": \"DR\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/DR\"\n },\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments?patient_id=6070\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/6070\"\n },\n \"primary_insurance_company_id\": \"1117\",\n \"primary_insurance_company\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies/1117\"\n },\n \"secondary_insurance_company_id\": \"\",\n \"primary_relationship\": \"Self\",\n \"country\": \"\",\n \"primary_medical_insurance\": \"\",\n \"primary_medical_insurance_id\": \"\",\n \"primary_medical_relationship\": \"\",\n \"primary_medical_subscriber_id\": \"\",\n \"secondary_medical_insurance\": \"\",\n \"secondary_medical_insurance_id\": \"\",\n \"secondary_medical_relationship\": \"\",\n \"secondary_medical_subscriber_id\": \"\",\n \"secondary_relationship\": \"\",\n \"subscriber_id\": \"\",\n \"patient_account_id\": \"\",\n \"other_referral\": \"\",\n \"patient_referral\": \"\",\n \"referred_out\": \"\",\n \"referred_by_provider_id\": \"\",\n \"referred_by_patient_id\": \"\",\n \"image\": \"\",\n \"thumb_image\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"Ttedda\",\n \"guarantor_last_name\": \"Sqode\",\n \"created_date\": \"2016-04-20\",\n \"preferred_contact\": \"\",\n \"hygienist\": \"LW\",\n \"patient_codes\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"f085d0d3-aca5-4c98-9c6c-ad4c4841c254"},{"name":"patients by patient_id","id":"95320f38-ee72-495f-ae21-b91f9c7d3c4a","request":{"method":"GET","header":[],"url":"{{url}}/patients/{patient_id}?request_key={{request_key}}","description":"

Get the information about patient based on patient id.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
guarantor_id	Guarantor id as per practice management systems	No
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
last_visit	Last Visit	No
cell	Cell Number	No
search	Search patient by firstname , lastname , email , middlename, city, state, zipcode, homephone, workphone, cell	No
status	Status of patient	No
phone	Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["patients","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"377a266b-f5e9-4f9d-9b74-87837fc11428","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patients/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["patients","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1883","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 10:10:08 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/6071\",\n \"patient_id\": \"6071\",\n \"guarantor_id\": \"5865\",\n \"firstname\": \"Wastde\",\n \"middlename\": \"\",\n \"lastname\": \"Kmade\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1926-12-26\",\n \"status\": \"Active\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"Male\",\n \"address_line1\": \"260ugdt\",\n \"address_line2\": \"\",\n \"city\": \"Peoria\",\n \"state\": \"IL\",\n \"zipcode\": \"61604\",\n \"homephone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"email\": \"\",\n \"employer_id\": \"1082_282\",\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/1082_282\"\n },\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"provider_id\": \"DR\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/DR\"\n },\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments?patient_id=6071\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/5865\"\n },\n \"primary_insurance_company_id\": \"1082\",\n \"primary_insurance_company\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies/1082\"\n },\n \"secondary_insurance_company_id\": \"\",\n \"primary_relationship\": \"Self\",\n \"country\": \"\",\n \"primary_medical_insurance\": \"\",\n \"primary_medical_insurance_id\": \"\",\n \"primary_medical_relationship\": \"\",\n \"primary_medical_subscriber_id\": \"\",\n \"secondary_medical_insurance\": \"\",\n \"secondary_medical_insurance_id\": \"\",\n \"secondary_medical_relationship\": \"\",\n \"secondary_medical_subscriber_id\": \"\",\n \"secondary_relationship\": \"\",\n \"subscriber_id\": \"\",\n \"patient_account_id\": \"\",\n \"other_referral\": \"\",\n \"patient_referral\": \"\",\n \"referred_out\": \"\",\n \"referred_by_provider_id\": \"\",\n \"referred_by_patient_id\": \"\",\n \"image\": \"\",\n \"thumb_image\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"Mastde\",\n \"guarantor_last_name\": \"Kugdt\",\n \"created_date\": \"2016-04-20\",\n \"preferred_contact\": \"\",\n \"hygienist\": \"LW\",\n \"patient_codes\": \"\"\n}"}],"_postman_id":"95320f38-ee72-495f-ae21-b91f9c7d3c4a"},{"name":"patients/dental_patients","id":"3d989408-884d-4c08-bdb7-e13ade8a9d04","request":{"method":"GET","header":[],"url":"{{url}}/patients/dental_patients?request_key={{request_key}}","description":"

This API will retrun dental patient's information, additional information to \"patients\" API.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
guarantor_id	Guarantor id as per practice management systems	No
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
last_visit	Last Visit	No
cell	Cell Number	No
search	Search patient by firstname , lastname , email , middlename, city, state, zipcode, homephone, workphone, cell	No
status	Status of patient	No
phone	Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
firstname	First name of patient, provider or guarantor
practice_id	Practice ID
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["patients","dental_patients"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"2ef65abd-3e30-4fd9-8d67-be0ebc0e2eb4","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patients/dental_patients?request_key={{request_key}}","host":["{{url}}"],"path":["patients","dental_patients"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"3732","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 05:31:00 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"5071\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/dental_patients/6071\",\n \"patient_id\": \"6071\",\n \"guarantor_id\": \"5865\",\n \"firstname\": \"Wastde\",\n \"middlename\": \"\",\n \"lastname\": \"Kmade\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1926-12-26\",\n \"status\": \"Active\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"Male\",\n \"marital_status\": \"Married\",\n \"address_line1\": \"260ugdt\",\n \"address_line2\": \"\",\n \"city\": \"Peoria\",\n \"state\": \"IL\",\n \"zipcode\": \"61604\",\n \"homephone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"email\": \"\",\n \"employer_id\": \"1082_282\",\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/1082_282\"\n },\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"referred_by_patient_id\": \"\",\n \"provider_id\": \"DR\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/DR\"\n },\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments?patient_id=6071\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/5865\"\n },\n \"primary_insurance_company_id\": \"1082\",\n \"primary_insurance_company\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies/1082\"\n },\n \"secondary_insurance_company_id\": \"\",\n \"primary_relationship\": \"Self\",\n \"country\": \"\",\n \"secondary_relationship\": \"\",\n \"primary_medical_insurance_id\": \"\",\n \"primary_medical_insurance\": \"\",\n \"primary_medical_relationship\": \"\",\n \"primary_medical_subscriber_id\": \"\",\n \"secondary_medical_insurance_id\": \"\",\n \"secondary_medical_insurance\": \"\",\n \"secondary_medical_subscriber_id\": \"\",\n \"other_referral\": \"\",\n \"patient_referral\": \"\",\n \"referred_out\": \"\",\n \"referred_by_provider_id\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"Mastde\",\n \"guarantor_last_name\": \"Kugdt\",\n \"created_date\": \"2016-04-20\",\n \"preferred_contact\": \"\",\n \"hygienist\": \"LW\",\n \"integration_ids\": \"\",\n \"patient_codes\": \"\",\n\t\t\t\t\"email_alert\": \"test\",\n\t\t\t\t\"text_alert\": \"demo\",\n\t\t\t\t\"voice_alert\": \"123\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/dental_patients/6070\",\n \"patient_id\": \"6070\",\n \"guarantor_id\": \"6070\",\n \"firstname\": \"Tastde\",\n \"middlename\": \"\",\n \"lastname\": \"Smade\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1967-06-20\",\n \"status\": \"Active\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"Male\",\n \"marital_status\": \"Married\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"Peoria\",\n \"state\": \"IL\",\n \"zipcode\": \"61614\",\n \"homephone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"email\": \"\",\n \"employer_id\": \"1117_38\",\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/1117_38\"\n },\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"referred_by_patient_id\": \"\",\n \"provider_id\": \"DR\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/DR\"\n },\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments?patient_id=6070\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/6070\"\n },\n \"primary_insurance_company_id\": \"1117\",\n \"primary_insurance_company\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies/1117\"\n },\n \"secondary_insurance_company_id\": \"\",\n \"primary_relationship\": \"Self\",\n \"country\": \"\",\n \"secondary_relationship\": \"\",\n \"primary_medical_insurance_id\": \"\",\n \"primary_medical_insurance\": \"\",\n \"primary_medical_relationship\": \"\",\n \"primary_medical_subscriber_id\": \"\",\n \"secondary_medical_insurance_id\": \"\",\n \"secondary_medical_insurance\": \"\",\n \"secondary_medical_subscriber_id\": \"\",\n \"other_referral\": \"\",\n \"patient_referral\": \"\",\n \"referred_out\": \"\",\n \"referred_by_provider_id\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"Ttedda\",\n \"guarantor_last_name\": \"Sqode\",\n \"created_date\": \"2016-04-20\",\n \"preferred_contact\": \"\",\n \"hygienist\": \"LW\",\n \"integration_ids\": \"\",\n \"patient_codes\": \"\",\n\t\t\t\t\"email_alert\": \"test\",\n\t\t\t\t\"text_alert\": \"demo\",\n\t\t\t\t\"voice_alert\": \"123\"\n }\n ]\n }\n]"}],"_postman_id":"3d989408-884d-4c08-bdb7-e13ade8a9d04"},{"name":"patients/dental_patients by patient_id","id":"53951c83-4bb3-4b0e-baaa-96120706f0fc","request":{"method":"GET","header":[],"url":"{{url}}/patients/dental_patients/{patient_id}?request_key={{request_key}}","description":"

Get the resource of dental patient as per patient id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
guarantor_id	Guarantor id as per practice management systems	No
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
last_visit	Last Visit	No
cell	Cell Number	No
search	Search patient by firstname , lastname , email , middlename, city, state, zipcode, homephone, workphone, cell	No
status	Status of patient	No
phone	Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
firstname	First name of patient, provider or guarantor
practice_id	Practice ID
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["patients","dental_patients","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"8b5ad46e-1288-47f5-8a14-01ef16f0b1be","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patients/dental_patients/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["patients","dental_patients","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1841","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 05:35:34 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/dental_patients/6071\",\n \"patient_id\": \"6071\",\n \"guarantor_id\": \"5865\",\n \"firstname\": \"Wastde\",\n \"middlename\": \"\",\n \"lastname\": \"Kmade\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1926-12-26\",\n \"status\": \"Active\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"Male\",\n \"marital_status\": \"Married\",\n \"address_line1\": \"260ugdt\",\n \"address_line2\": \"\",\n \"city\": \"Peoria\",\n \"state\": \"IL\",\n \"zipcode\": \"61604\",\n \"homephone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"email\": \"\",\n \"employer_id\": \"1082_282\",\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/1082_282\"\n },\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"referred_by_patient_id\": \"\",\n \"provider_id\": \"DR\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/DR\"\n },\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments?patient_id=6071\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/5865\"\n },\n \"primary_insurance_company_id\": \"1082\",\n \"primary_insurance_company\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies/1082\"\n },\n \"secondary_insurance_company_id\": \"\",\n \"primary_relationship\": \"Self\",\n \"country\": \"\",\n \"secondary_relationship\": \"\",\n \"primary_medical_insurance_id\": \"\",\n \"primary_medical_insurance\": \"\",\n \"primary_medical_relationship\": \"\",\n \"primary_medical_subscriber_id\": \"\",\n \"secondary_medical_insurance_id\": \"\",\n \"secondary_medical_insurance\": \"\",\n \"secondary_medical_subscriber_id\": \"\",\n \"other_referral\": \"\",\n \"patient_referral\": \"\",\n \"referred_out\": \"\",\n \"referred_by_provider_id\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"Mastde\",\n \"guarantor_last_name\": \"Kugdt\",\n \"created_date\": \"2016-04-20\",\n \"preferred_contact\": \"\",\n \"hygienist\": \"LW\",\n \"integration_ids\": \"\",\n \"patient_codes\": \"\",\n\t\"email_alert\": \"test\",\n\t\"text_alert\": \"demo\",\n\t\"voice_alert\": \"123\"\n}"}],"_postman_id":"53951c83-4bb3-4b0e-baaa-96120706f0fc"},{"name":"patients/audiology_patients","id":"4ba084b1-fc27-4450-9d78-f8b452897c1b","request":{"method":"GET","header":[],"url":"{{url}}/patients/audiology_patients?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
patient_id	Patient ID as per the management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
last_visit	Last Visit	No
cell	Cell Number	No
search	Search patient by firstname , lastname , email , middlename, city, state, zipcode, homephone, workphone, cell	No
status	Status of patient	No
phone	Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["patients","audiology_patients"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"0e6c8a80-45ff-4749-bd8d-7aa180555310","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patients/audiology_patients?request_key={{request_key}}","host":["{{url}}"],"path":["patients","audiology_patients"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"2988","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 05:25:13 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"10560\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/patients/audiology_patients/11115\",\n \"patient_id\": \"11115\",\n \"guarantor_id\": \"11115\",\n \"firstname\": \"Sdfdd\",\n \"middlename\": \"\",\n \"lastname\": \"Dmade\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1920-02-02\",\n \"status\": \"Prospect\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"\",\n \"marital_status\": \"unknown\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"CA\",\n \"zipcode\": \"95035\",\n \"homephone\": \"xxxxxxxxxx\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"email\": \"\",\n \"employer_id\": \"9001\",\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/employers/9001\"\n },\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"referred_by_patient_id\": \"\",\n \"provider_id\": \"20\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/providers/20\"\n },\n \"practice_id\": \"1-632\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/appointments?patient_id=11115\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/guarantors/11115\"\n },\n \"primary_insurance_company_id\": \"Aetna\",\n \"primary_insurance_company\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/insurance_companies/Aetna\"\n },\n \"secondary_insurance_company_id\": \"\",\n \"primary_relationship\": \"\",\n \"secondary_relationship\": \"\",\n \"other_referral\": \"Physician Referral\",\n \"patient_referral\": \"\",\n \"referred_out\": \"Null\",\n \"referred_by_provider_id\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"Sdfdd\",\n \"guarantor_last_name\": \"Dqode\",\n \"created_date\": \"\",\n \"patient_codes\": \"\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/patients/audiology_patients/11114\",\n \"patient_id\": \"11114\",\n \"guarantor_id\": \"11114\",\n \"firstname\": \"Hpoie\",\n \"middlename\": \"\",\n \"lastname\": \"Smade\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1957-11-19\",\n \"status\": \"Prospect\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"Male\",\n \"marital_status\": \"married\",\n \"address_line1\": \"167made\",\n \"address_line2\": \"\",\n \"city\": \"Morgan Hill\",\n \"state\": \"CA\",\n \"zipcode\": \"95037\",\n \"homephone\": \"xxxxxxxxxx\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"email\": \"ho65s@sn6h\",\n \"employer_id\": \"\",\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"referred_by_patient_id\": \"\",\n \"provider_id\": \"36\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/providers/36\"\n },\n \"practice_id\": \"1-632\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/appointments?patient_id=11114\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/guarantors/11114\"\n },\n \"primary_insurance_company_id\": \"\",\n \"secondary_insurance_company_id\": \"\",\n \"primary_relationship\": \"\",\n \"secondary_relationship\": \"\",\n \"other_referral\": \"Online\",\n \"patient_referral\": \"\",\n \"referred_out\": \"Null\",\n \"referred_by_provider_id\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"Htedda\",\n \"guarantor_last_name\": \"Sugdt\",\n \"created_date\": \"\",\n \"patient_codes\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"4ba084b1-fc27-4450-9d78-f8b452897c1b"},{"name":"patients/audiology_patients by patient_id","id":"59e29958-23a1-4236-b05c-d37a3f3987fa","request":{"method":"GET","header":[],"url":"{{url}}/patients/audiology_patients/{patient_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
patient_id	Patient ID as per the management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
last_visit	Last Visit	No
cell	Cell Number	No
search	Search patient by firstname , lastname , email , middlename, city, state, zipcode, homephone, workphone, cell	No
status	Status of patient	No
phone	Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["patients","audiology_patients","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"79b33674-06a4-47a7-85d3-42072e072ba5","name":"sample response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patients/audiology_patients/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["patients","audiology_patients","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1560","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 05:28:55 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/patients/audiology_patients/11115\",\n \"patient_id\": \"11115\",\n \"guarantor_id\": \"11115\",\n \"firstname\": \"Sdfdd\",\n \"middlename\": \"\",\n \"lastname\": \"Dmade\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"1920-02-02\",\n \"status\": \"Prospect\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"\",\n \"marital_status\": \"unknown\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"CA\",\n \"zipcode\": \"95035\",\n \"homephone\": \"xxxxxxxxxx\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"email\": \"\",\n \"employer_id\": \"9001\",\n \"employer\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/employers/9001\"\n },\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"referred_by_patient_id\": \"\",\n \"provider_id\": \"20\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/providers/20\"\n },\n \"practice_id\": \"1-632\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/appointments?patient_id=11115\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/guarantors/11115\"\n },\n \"primary_insurance_company_id\": \"Aetna\",\n \"primary_insurance_company\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-632/insurance_companies/Aetna\"\n },\n \"secondary_insurance_company_id\": \"\",\n \"primary_relationship\": \"\",\n \"secondary_relationship\": \"\",\n \"other_referral\": \"Physician Referral\",\n \"patient_referral\": \"\",\n \"referred_out\": \"Null\",\n \"referred_by_provider_id\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"Sdfdd\",\n \"guarantor_last_name\": \"Dqode\",\n \"created_date\": \"\",\n \"patient_codes\": \"\"\n}"}],"_postman_id":"59e29958-23a1-4236-b05c-d37a3f3987fa"},{"name":"patients/shelter_patients","id":"d28e58b7-2f3d-4029-88b0-a4213a5125b2","request":{"method":"GET","header":[],"url":"{{url}}/patients/shelter_patients?request_key={{request_key}}","description":"

Shelter patients API returns information about pets as per shelter practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
petname	Name of Pet	No
request_key	Valid 32 characters alpha-numeric request key	Yes
guarantor_id	Guarantor id as per practice management systems	No
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
adoption_status_date	Filter on adoption_status_date field, format: yyyy-mm-dd	No
search	Search patient by petname	No
status	Status of patient	No
microchip	Microchip ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
petname	Name of Pet
patient_id	Patient ID as per the management system

","urlObject":{"path":["patients","shelter_patients"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"6dae8b4c-ae9f-4076-addc-8d7312493e0c","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patients/shelter_patients?request_key={{request_key}}","host":["{{url}}"],"path":["patients","shelter_patients"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"4041","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 05:43:07 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"38343\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-56/patients/shelter_patients/191567\",\n \"patient_id\": \"191567\",\n \"guarantor_id\": \"194679\",\n \"firstname\": \"Ares\",\n \"middlename\": \"\",\n \"lastname\": \"\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"2013-10-09\",\n \"status\": \"Adopted\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"Male\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"homephone\": \"442 079 5511\",\n \"workphone\": \"\",\n \"cell\": \"760 171 0835\",\n \"email\": \"sbdelitz21@gmail.com\",\n \"employer_id\": \"\",\n \"billing_type\": \"\",\n \"first_visit\": \"2015-10-09\",\n \"last_visit\": \"\",\n \"provider_id\": \"\",\n \"practice_id\": \"1-56\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-56\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-56/appointments?patient_id=191567\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-56/guarantors/194679\"\n },\n \"primary_insurance_company_id\": \"\",\n \"secondary_insurance_company_id\": \"\",\n \"primary_relationship\": \"\",\n \"country\": \"\",\n \"primary_medical_insurance\": \"\",\n \"primary_medical_insurance_id\": \"\",\n \"primary_medical_relationship\": \"\",\n \"primary_medical_subscriber_id\": \"\",\n \"secondary_medical_insurance\": \"\",\n \"secondary_medical_insurance_id\": \"\",\n \"secondary_medical_relationship\": \"\",\n \"secondary_medical_subscriber_id\": \"\",\n \"secondary_relationship\": \"\",\n \"subscriber_id\": \"\",\n \"patient_account_id\": \"\",\n \"other_referral\": \"\",\n \"patient_referral\": \"\",\n \"referred_out\": \"Null\",\n \"referred_by_provider_id\": \"\",\n \"referred_by_patient_id\": \"\",\n \"image\": \"\",\n \"thumb_image\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"Svetla\",\n \"guarantor_last_name\": \"Fielitz\",\n \"petname\": \"Ares\",\n \"breed\": \"Australian Cattle Dog / Blue Heeler\",\n \"primary_or_secondary_color\": \"Black | Brown\",\n \"weight\": \"43 lbs\",\n \"age\": \"2 Years 10 Months 2 Weeks\",\n \"microchip\": \"9410000152593 |\",\n \"contact_location\": \"Region 56\",\n \"adoption_status_date\": \"2015-10-10\",\n \"record_type\": \"Person\",\n \"type\": \"Dog\",\n \"size\": \"\",\n \"source\": \"Owner Surrender\",\n \"spayed_neutered\": \"Yes\",\n \"veterinary_clinic_id\": \"3\",\n \"created_date\": \"\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-53/patients/shelter_patients/191369\",\n \"patient_id\": \"191369\",\n \"guarantor_id\": \"194785\",\n \"firstname\": \"Milo\",\n \"middlename\": \"\",\n \"lastname\": \"\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"2015-05-24\",\n \"status\": \"Adopted\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"Male\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"homephone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"804 072 0644\",\n \"email\": \"sbdevy31@gmail.com\",\n \"employer_id\": \"\",\n \"billing_type\": \"\",\n \"first_visit\": \"2015-10-07\",\n \"last_visit\": \"\",\n \"provider_id\": \"\",\n \"practice_id\": \"1-53\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-53\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-53/appointments?patient_id=191369\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-53/guarantors/194785\"\n },\n \"primary_insurance_company_id\": \"\",\n \"secondary_insurance_company_id\": \"\",\n \"primary_relationship\": \"\",\n \"country\": \"\",\n \"primary_medical_insurance\": \"\",\n \"primary_medical_insurance_id\": \"\",\n \"primary_medical_relationship\": \"\",\n \"primary_medical_subscriber_id\": \"\",\n \"secondary_medical_insurance\": \"\",\n \"secondary_medical_insurance_id\": \"\",\n \"secondary_medical_relationship\": \"\",\n \"secondary_medical_subscriber_id\": \"\",\n \"secondary_relationship\": \"\",\n \"subscriber_id\": \"\",\n \"patient_account_id\": \"\",\n \"other_referral\": \"\",\n \"patient_referral\": \"\",\n \"referred_out\": \"Null\",\n \"referred_by_provider_id\": \"\",\n \"referred_by_patient_id\": \"\",\n \"image\": \"\",\n \"thumb_image\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"Penny\",\n \"guarantor_last_name\": \"Baley\",\n \"petname\": \"Milo\",\n \"breed\": \"Domestic Short Hair\",\n \"primary_or_secondary_color\": \"Silver Tabby | White\",\n \"weight\": \"5.7 lbs\",\n \"age\": \"1 Years 2 Months 4 Weeks\",\n \"microchip\": \"985112006313 |\",\n \"contact_location\": \"Region 53\",\n \"adoption_status_date\": \"2015-10-11\",\n \"record_type\": \"Person\",\n \"type\": \"Cat\",\n \"size\": \"\",\n \"source\": \"Owner Surrender\",\n \"spayed_neutered\": \"Yes\",\n \"veterinary_clinic_id\": \"\",\n \"created_date\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"d28e58b7-2f3d-4029-88b0-a4213a5125b2"},{"name":"patients/shelter_patients by patient_id","id":"2749e02b-bb6a-4ba2-b66a-9e109ab0c2c7","request":{"method":"GET","header":[],"url":"{{url}}/patients/shelter_patients/{patient_id}?request_key={{request_key}}","description":"

Shelter patients API returns information about pet as per shelter practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
petname	Name of Pet	No
request_key	Valid 32 characters alpha-numeric request key	Yes
guarantor_id	Guarantor id as per practice management systems	No
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
adoption_status_date	Filter on adoption_status_date field, format: yyyy-mm-dd	No
search	Search patient by petname	No
status	Status of patient	No
microchip	Microchip ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
petname	Name of Pet
patient_id	Patient ID as per the management system

","urlObject":{"path":["patients","shelter_patients","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"9a9baf97-5884-43c4-af64-deae8dbc365f","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patients/shelter_patients/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["patients","shelter_patients","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n\t\"href\": \"https://api.sikkasoft.com/v2/practices/1-56/patients/shelter_patients/19xxx7\",\r\n\t\"patient_id\": \"19xxx7\",\r\n\t\"guarantor_id\": \"19xxx9\",\r\n\t\"firstname\": \"FName\",\r\n\t\"middlename\": \"\",\r\n\t\"lastname\": \"LName\",\r\n\t\"preferred_name\": \"\",\r\n\t\"salutation\": \"\",\r\n\t\"birthdate\": \"1989-07-11\",\r\n\t\"status\": \"Adopted\",\r\n\t\"patient_note\": \"\",\r\n\t\"medical_note\": \"\",\r\n\t\"alert_note\": \"\",\r\n\t\"other_note\": \"\",\r\n\t\"gender\": \"Male\",\r\n\t\"address_line1\": \"\",\r\n\t\"address_line2\": \"\",\r\n\t\"city\": \"\",\r\n\t\"state\": \"\",\r\n\t\"zipcode\": \"\",\r\n\t\"homephone\": \"xxx xxx xxxx\",\r\n\t\"workphone\": \"\",\r\n\t\"cell\": \"xxx xxx xxxx\",\r\n\t\"email\": \"sbdeitz21@gmail.com\",\r\n\t\"employer_id\": \"\",\r\n\t\"billing_type\": \"\",\r\n\t\"first_visit\": \"2015-10-09\",\r\n\t\"last_visit\": \"\",\r\n\t\"provider_id\": \"\",\r\n\t\"practice_id\": \"1-56\",\r\n\t\"practice\": {\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-56\"\r\n\t},\r\n\t\"appointments\": {\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-56/appointments?patient_id=19xxx7\"\r\n\t},\r\n\t\"guarantor\": {\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-56/guarantors/19xxx9\"\r\n\t},\r\n\t\"primary_insurance_company_id\": \"\",\r\n\t\"secondary_insurance_company_id\": \"\",\r\n\t\"primary_relationship\": \"\",\r\n\t\"country\": \"\",\r\n\t\"primary_medical_insurance\": \"\",\r\n\t\"primary_medical_insurance_id\": \"\",\r\n\t\"primary_medical_relationship\": \"\",\r\n\t\"primary_medical_subscriber_id\": \"\",\r\n\t\"secondary_medical_insurance\": \"\",\r\n\t\"secondary_medical_insurance_id\": \"\",\r\n\t\"secondary_medical_relationship\": \"\",\r\n\t\"secondary_medical_subscriber_id\": \"\",\r\n\t\"secondary_relationship\": \"\",\r\n\t\"subscriber_id\": \"\",\r\n\t\"patient_account_id\": \"\",\r\n\t\"other_referral\": \"\",\r\n\t\"patient_referral\": \"\",\r\n\t\"referred_out\": \"Null\",\r\n\t\"referred_by_provider_id\": \"\",\r\n\t\"referred_by_patient_id\": \"\",\r\n\t\"image\": \"\",\r\n\t\"thumb_image\": \"\",\r\n\t\"fee_no\": \"\",\r\n\t\"guarantor_first_name\": \"GName\",\r\n\t\"guarantor_last_name\": \"Gname1\",\r\n\t\"petname\": \"Ares\",\r\n\t\"breed\": \"Australian Cattle Dog / Blue Heeler\",\r\n\t\"primary_or_secondary_color\": \"Black | Brown\",\r\n\t\"weight\": \"43 lbs\",\r\n\t\"age\": \"2 Years 10 Months 2 Weeks\",\r\n\t\"microchip\": \"xxxxxxxxxx |\",\r\n\t\"contact_location\": \"Region 56\",\r\n\t\"adoption_status_date\": \"2015-10-10\",\r\n\t\"record_type\": \"Person\",\r\n\t\"type\": \"Dog\",\r\n\t\"size\": \"\",\r\n\t\"source\": \"Owner Surrender\",\r\n\t\"spayed_neutered\": \"Yes\",\r\n\t\"veterinary_clinic_id\": \"3\",\r\n\t\"created_date\": \"2014-12-14\"\r\n}"}],"_postman_id":"2749e02b-bb6a-4ba2-b66a-9e109ab0c2c7"},{"name":"patients/veterinary_patients","id":"c05db0d1-8eec-46e4-9052-47c791068574","request":{"method":"GET","header":[],"url":"{{url}}/patients/veterinary_patients?request_key={{request_key}}","description":"

Display additional properties to patient API. This API will returns more fields about pets(animals)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
patient_id	Patient ID as per the management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
last_visit	Last Visit	No
cell	Cell Number	No
fields	fields parameter allows to return only requested fields with mandatory fields.	No
search	Search patient by firstname , lastname , email , middlename, city, state, zipcode, homephone, workphone, cell	No
status	Status of patient	No
phone	Phone Number	No
microchip	Microchip ID	No
rabies	Rabies ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["patients","veterinary_patients"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"e2206b1d-6ed3-4e12-a965-bf9ca2ada66a","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patients/veterinary_patients?request_key={{request_key}}","host":["{{url}}"],"path":["patients","veterinary_patients"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"3135","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 05:49:57 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"14916\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/veterinary_patients/12867-0\",\n \"patient_id\": \"12867-0\",\n \"guarantor_id\": \"12867\",\n \"firstname\": \"\",\n \"middlename\": \"\",\n \"lastname\": \"\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"\",\n \"status\": \"Active\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"\",\n \"marital_status\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"(None)\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"homephone\": \"-(231645\",\n \"workphone\": \"-(231645\",\n \"cell\": \"- 123486\",\n \"email\": \"\",\n \"employer_id\": \"\",\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"referred_by_patient_id\": \"\",\n \"provider_id\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments?patient_id=12867-0\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/12867\"\n },\n \"primary_insurance_company_id\": \"\",\n \"secondary_insurance_company_id\": \"\",\n \"secondary_relationship\": \"\",\n \"petname\": \"\",\n \"breed\": \"\",\n \"species\": \"\",\n \"color\": \"\",\n \"weight\": \"0\",\n \"weight_type\": \"lb\",\n \"height\": \"\",\n \"age\": \"\",\n \"code\": \"\",\n \"suspended_date\": \"\",\n \"deceased_date\": \"\",\n \"rabies\": \"\",\n \"feed\": \"\",\n \"diet\": \"\",\n \"pet_class\": \"\",\n \"certificate\": \"\",\n \"epet_record_id\": \"\",\n \"microchip\": \"\",\n \"trainer\": \"\",\n \"registered_name\": \"\",\n \"plan\": \"\",\n \"relative_name\": \"\",\n \"codes\": \"\",\n \"mixed\": \"\",\n \"added_by\": \"\",\n \"other_referral\": \"\",\n \"patient_referral\": \"\",\n \"referred_out\": \"Null\",\n \"referred_by_provider_id\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"(made\",\n \"created_date\": \"\",\n \"patient_codes\": \"\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/veterinary_patients/6666-0\",\n \"patient_id\": \"6666-0\",\n \"guarantor_id\": \"6666\",\n \"firstname\": \"\",\n \"middlename\": \"\",\n \"lastname\": \"\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"\",\n \"status\": \"\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"\",\n \"marital_status\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"Dundas\",\n \"state\": \"ON\",\n \"zipcode\": \"L9H1B9\",\n \"homephone\": \"(91234\",\n \"workphone\": \"(9231645\",\n \"cell\": \"- 8233423\",\n \"email\": \"dr65s@sn6h1a\",\n \"employer_id\": \"\",\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"referred_by_patient_id\": \"\",\n \"provider_id\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments?patient_id=6666-0\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/6666\"\n },\n \"primary_insurance_company_id\": \"\",\n \"secondary_insurance_company_id\": \"\",\n \"secondary_relationship\": \"\",\n \"petname\": \"\",\n \"breed\": \"\",\n \"species\": \"\",\n \"color\": \"\",\n \"weight\": \"0\",\n \"weight_type\": \"lb\",\n \"height\": \"\",\n \"age\": \"\",\n \"code\": \"\",\n \"suspended_date\": \"\",\n \"deceased_date\": \"\",\n \"rabies\": \"\",\n \"feed\": \"\",\n \"diet\": \"\",\n \"pet_class\": \"\",\n \"certificate\": \"\",\n \"epet_record_id\": \"\",\n \"microchip\": \"\",\n \"trainer\": \"\",\n \"registered_name\": \"\",\n \"plan\": \"\",\n \"relative_name\": \"\",\n \"codes\": \"\",\n \"mixed\": \"\",\n \"added_by\": \"\",\n \"other_referral\": \"(None)\",\n \"patient_referral\": \"\",\n \"referred_out\": \"Null\",\n \"referred_by_provider_id\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"Mdfdd\",\n \"guarantor_last_name\": \"Wmade\",\n \"created_date\": \"\",\n \"patient_codes\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"c05db0d1-8eec-46e4-9052-47c791068574"},{"name":"patients/veterinary_patients by patient_id","id":"2ff13d8b-4955-426b-af22-66cc2e3de755","request":{"method":"GET","header":[],"url":"{{url}}/patients/veterinary_patients/{patient_id}?request_key={{request_key}}","description":"

Display patient information as per patient id. In this API it is pet information.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
patient_id	Patient ID as per the management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
last_visit	Last Visit	No
cell	Cell Number	No
fields	fields parameter allows to return only requested fields with mandatory fields.	No
search	Search patient by firstname , lastname , email , middlename, city, state, zipcode, homephone, workphone, cell	No
status	Status of patient	No
phone	Phone Number	No
microchip	Microchip ID	No
rabies	Rabies ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["patients","veterinary_patients","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"c571d2a0-f10e-4b84-ad35-5d78f2fef638","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patients/veterinary_patients/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["patients","veterinary_patients","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1528","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 05:54:19 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/veterinary_patients/12867-0\",\n \"patient_id\": \"12867-0\",\n \"guarantor_id\": \"12867\",\n \"firstname\": \"\",\n \"middlename\": \"\",\n \"lastname\": \"\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"birthdate\": \"\",\n \"status\": \"Active\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"\",\n \"marital_status\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"(None)\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"homephone\": \"-(231645\",\n \"workphone\": \"-(231645\",\n \"cell\": \"- 123486\",\n \"email\": \"\",\n \"employer_id\": \"\",\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"referred_by_patient_id\": \"\",\n \"provider_id\": \"\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments?patient_id=12867-0\"\n },\n \"guarantor\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/12867\"\n },\n \"primary_insurance_company_id\": \"\",\n \"secondary_insurance_company_id\": \"\",\n \"secondary_relationship\": \"\",\n \"petname\": \"\",\n \"breed\": \"\",\n \"species\": \"\",\n \"color\": \"\",\n \"weight\": \"0\",\n \"weight_type\": \"lb\",\n \"height\": \"\",\n \"age\": \"\",\n \"code\": \"\",\n \"suspended_date\": \"\",\n \"deceased_date\": \"\",\n \"rabies\": \"\",\n \"feed\": \"\",\n \"diet\": \"\",\n \"pet_class\": \"\",\n \"certificate\": \"\",\n \"epet_record_id\": \"\",\n \"microchip\": \"\",\n \"trainer\": \"\",\n \"registered_name\": \"\",\n \"plan\": \"\",\n \"relative_name\": \"\",\n \"codes\": \"\",\n \"mixed\": \"\",\n \"added_by\": \"\",\n \"other_referral\": \"\",\n \"patient_referral\": \"\",\n \"referred_out\": \"Null\",\n \"referred_by_provider_id\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"(made\",\n \"created_date\": \"\",\n \"patient_codes\": \"\"\n}"}],"_postman_id":"2ff13d8b-4955-426b-af22-66cc2e3de755"},{"name":"patient_addresses","id":"73ef4e89-db0d-4617-8f0e-7e0f333f56f3","request":{"method":"GET","header":[],"url":"{{url}}/patient_addresses?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["patient_addresses"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"327e0836-d639-4960-816f-6b12357bb3a1","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_addresses?request_key={{request_key}}","host":["{{url}}"],"path":["patient_addresses"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"822","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:45:32 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"offset\": \"0\",\r\n \"limit\": \"2\",\r\n \"total_count\": \"138529\",\r\n \"execution_time\": \"123\",\r\n \"items\": [\r\n {\r\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-TEST/patient_addresses/TEST-517186\",\r\n \"patient_id\": \"TEST-517186\",\r\n \"patient\": {\r\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-TEST/patients/TEST-517186\"\r\n },\r\n \"address_line1\": \"271 Test St\",\r\n \"address_line2\": \"2nd Line\",\r\n \"city\": \"Test_City\",\r\n \"state\": \"CA\",\r\n \"zipcode\": \"99999\",\r\n \"rank\": \"1\",\r\n \"practice_id\": \"1-TEST\",\r\n \"practice\": {\r\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-TEST\"\r\n }\r\n },\r\n {\r\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-TEST/patient_addresses/TEST-517160\",\r\n \"patient_id\": \"TEST-517160\",\r\n \"patient\": {\r\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-TEST/patients/TEST-517160\"\r\n },\r\n \"address_line1\": \"10623 Test Ct.\",\r\n \"address_line2\": \"\",\r\n \"city\": \"Test_City\",\r\n \"state\": \"KY\",\r\n \"zipcode\": \"99999\",\r\n \"rank\": \"1\",\r\n \"practice_id\": \"1-TEST\",\r\n \"practice\": {\r\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-TEST\"\r\n }\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"73ef4e89-db0d-4617-8f0e-7e0f333f56f3"},{"name":"patient_addresses by patient_id","id":"8aeb12cb-839f-4f8d-995b-4b20447dc650","request":{"method":"GET","header":[],"url":"{{url}}/patient_addresses/{patient_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["patient_addresses","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"7315f7a6-d764-4d83-be3f-250878da969b","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_addresses/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["patient_addresses","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"1\",\n \"execution_time\": \"95\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-TEST/patient_addresses/TEST-517186\",\n \"patient_id\": \"TEST-517186\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-TEST/patients/TEST-517186\"\n },\n \"address_line1\": \"271 Test St\",\n \"address_line2\": \"2nd Line\",\n \"city\": \"Test_City\",\n \"state\": \"CA\",\n \"zipcode\": \"99999\",\n \"rank\": \"1\",\n \"practice_id\": \"1-TEST\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-TEST\"\n }\n }\n ]\n }\n]"}],"_postman_id":"8aeb12cb-839f-4f8d-995b-4b20447dc650"},{"name":"patient_charts","id":"398bc698-7464-481f-8208-ab03e9f014a0","request":{"method":"GET","header":[],"url":"{{url}}/patient_charts?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
date	Filter on date field, format: yyyy-mm-dd	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID
date	Filter on date field, format: yyyy-mm-dd

","urlObject":{"path":["patient_charts"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"2ce9dd6a-1b84-4865-ba95-c5c3390c851d","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_charts?request_key={{request_key}}","host":["{{url}}"],"path":["patient_charts"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"817","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:26:42 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"119218\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_charts\\/355205\",\"patient_id\":\"355205\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/355205\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"tooth_number\":\"01\",\"surface\":\"\",\"chart_date\":\"2017-04-05\",\"description\":\"Charted Unerupted\",\"type\":\"\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_charts\\/355205\",\"patient_id\":\"355205\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/355205\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"tooth_number\":\"02\",\"surface\":\"\",\"chart_date\":\"2017-04-05\",\"description\":\"Charted Unerupted\",\"type\":\"\"}]}]\r\n"}],"_postman_id":"398bc698-7464-481f-8208-ab03e9f014a0"},{"name":"patient_charts by patient_id","id":"4ba85d89-40e9-402a-b73c-f87199aa065e","request":{"method":"GET","header":[],"url":"{{url}}/patient_charts/{patient_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
date	Filter on date field, format: yyyy-mm-dd	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID
date	Filter on date field, format: yyyy-mm-dd

","urlObject":{"path":["patient_charts","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"cae84dcf-8e91-4a0c-8fdf-d5232ca56b8c","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_charts/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["patient_charts","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"436","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:29:35 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"1\",\"total_count\":\"32\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_charts\\/355205\",\"patient_id\":\"355205\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/355205\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"tooth_number\":\"32\",\"surface\":\"\",\"chart_date\":\"2017-04-05\",\"description\":\"Charted Unerupted\",\"type\":\"\"}]}]\r\n"}],"_postman_id":"4ba85d89-40e9-402a-b73c-f87199aa065e"},{"name":"patient_conditions","id":"840a291b-b618-477d-800a-151936bc30b4","request":{"method":"GET","header":[],"url":"{{url}}/patient_conditions?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

","urlObject":{"path":["patient_conditions"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"0eac0aec-4c6d-457c-8417-29f82435e666","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_conditions?request_key={{request_key}}","host":["{{url}}"],"path":["patient_conditions"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"927","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:40:10 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"19640\",\"items\":[{\"patient_condition_id\":\"10309\",\"patient_id\":\"1962\",\"entered_date\":\"2016-04-21\",\"description\":\"Chipped Tooth\",\"surface\":\"L\",\"provider_id\":\"DR\",\"tooth\":\"23\",\"no_longer_present\":\"N\",\"practice_id\":\"1\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/1962\"},\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"}},{\"patient_condition_id\":\"10309\",\"patient_id\":\"1962\",\"entered_date\":\"2016-04-21\",\"description\":\"Chipped Tooth\",\"surface\":\"L\",\"provider_id\":\"DR\",\"tooth\":\"23\",\"no_longer_present\":\"\",\"practice_id\":\"0\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/0\\/patients\\/1962\"},\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/0\"},\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/0\\/providers\\/DR\"}}]}]\r\n"}],"_postman_id":"840a291b-b618-477d-800a-151936bc30b4"},{"name":"patient_conditions by patient_condition_id","id":"2e3a5274-fcf2-498f-bc62-8ded34a65212","request":{"method":"GET","header":[],"url":"{{url}}/patient_conditions/{patient_condition_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

","urlObject":{"path":["patient_conditions","{patient_condition_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"a695a754-d065-4509-a2a8-2d42ade6e05e","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_conditions/{patient_condition_id}?request_key={{request_key}}","host":["{{url}}"],"path":["patient_conditions","{patient_condition_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"434","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:42:48 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"patient_condition_id\":\"10309\",\"patient_id\":\"1962\",\"entered_date\":\"2016-04-21\",\"description\":\"Chipped Tooth\",\"surface\":\"L\",\"provider_id\":\"DR\",\"tooth\":\"23\",\"no_longer_present\":\"N\",\"practice_id\":\"1\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/1962\"},\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"}}\r\n"}],"_postman_id":"2e3a5274-fcf2-498f-bc62-8ded34a65212"},{"name":"patient_contracts","id":"8cac5beb-6c0b-46d9-a191-cd64b26c84d6","request":{"method":"GET","header":[],"url":"{{url}}/patient_contracts?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
offset	offset – page number, default 0	No
limit	records per page, default 500, maximum 5000	No
sort_by	order by field name, for valid field name(s) refer below table	No
sort_order	desc or asc, default desc	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["patient_contracts"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"1667c687-7d23-4ed2-b6d6-6939a66c86a7","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_contracts?request_key={{request_key}}","host":["{{url}}"],"path":["patient_contracts"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"822","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:45:32 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"9621\",\n \"execution_time\": \"197\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-AB/patient_contracts/AB-003619\",\n \"patient_id\": \"AB-003619\",\n \"patient\": {\n \"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-AB/patients/AB-003619\"\n },\n \"patient_name\": \"Test Name\",\n \"startdate\": \"2017-05-16\",\n \"enddate\": \"2019-02-01\",\n \"gross_amount\": \"5295.0000\",\n \"net_amount\": \"3300.0000\",\n \"discount_amount\": \"1995.0000\",\n \"paid_amount\": \"1675.0000\",\n \"initial_amount\": \"\",\n \"contract_period\": \"\",\n \"status\": \"Comprehensive Treatment\",\n \"practice_id\": \"1-AB\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-AB\"\n },\n \"provider_id\": \"\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-AB/providers\"\n },\n \"contract_type\": \"\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-AB/patient_contracts/AB-010650\",\n \"patient_id\": \"AB-010650\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-AB/patients/AB-010650\"\n },\n \"patient_name\": \"Test Name\",\n \"startdate\": \"\",\n \"enddate\": \"2017-07-10\",\n \"gross_amount\": \"5375.0000\",\n \"net_amount\": \"5375.0000\",\n \"discount_amount\": \"0.0000\",\n \"paid_amount\": \"5375.0000\",\n \"initial_amount\": \"\",\n \"contract_period\": \"\",\n \"status\": \"Comprehensive Treatment\",\n \"practice_id\": \"1-AB\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-AB\"\n },\n \"provider_id\": \"\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-AB/providers\"\n },\n \"contract_type\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"8cac5beb-6c0b-46d9-a191-cd64b26c84d6"},{"name":"patient_contracts by patient_id","id":"7c40b2ec-a6a5-4dbe-ab56-c79f7024ea07","request":{"method":"GET","header":[],"url":"{{url}}/patient_contracts/{patient_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
offset	offset – page number, default 0	No
limit	records per page, default 500, maximum 5000	No
sort_by	order by field name, for valid field name(s) refer below table	No
sort_order	desc or asc, default desc	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["patient_contracts","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"c63769fa-5b83-44b0-a47a-2c581d4056c8","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_contracts/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["patient_contracts","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"419","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:47:33 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"500\",\n \"total_count\": \"1\",\n \"execution_time\": \"400\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-AB/patient_contracts/AB-003619\",\n \"patient_id\": \"AB-003619\",\n \"patient\": {\n \"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-AB/patients/AB-003619\"\n },\n \"patient_name\": \"Test Name\",\n \"startdate\": \"2017-05-16\",\n \"enddate\": \"2019-02-01\",\n \"gross_amount\": \"5295.0000\",\n \"net_amount\": \"3300.0000\",\n \"discount_amount\": \"1995.0000\",\n \"paid_amount\": \"1675.0000\",\n \"initial_amount\": \"\",\n \"contract_period\": \"\",\n \"status\": \"Comprehensive Treatment\",\n \"practice_id\": \"1-AB\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-AB\"\n },\n \"provider_id\": \"\",\n \"provider\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1-AB/providers\"\n },\n \"contract_type\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"7c40b2ec-a6a5-4dbe-ab56-c79f7024ea07"},{"name":"patient_documents","id":"af69c934-52e7-461e-9e8d-12d92b6e0cf7","request":{"method":"GET","header":[],"url":"{{url}}/patient_documents?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["patient_documents"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"ef586951-2ff6-4cbc-a2db-f52a30fd31b1","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_documents?request_key={{request_key}}","host":["{{url}}"],"path":["patient_documents"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"822","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:45:32 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"5348\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_documents\\/355203\",\"patient_id\":\"355203\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/355203\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"document_path\":\"\\\\\\\\Nt-fs1\\\\Share\\\\SoftDent\\\\PWImages\\\\Patient\\\\34\\\\5134\\\\C1.sc\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_documents\\/355201\",\"patient_id\":\"355201\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/355201\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"document_path\":\"\\\\\\\\Nt-fs1\\\\Share\\\\SoftDent\\\\PWImages\\\\Patient\\\\31\\\\5131\\\\Other\\\\SDPatientDoc_5131_04_06_2017_07_35_18.jpg\"}]}]\r\n"}],"_postman_id":"af69c934-52e7-461e-9e8d-12d92b6e0cf7"},{"name":"patient_documents by patient_id","id":"2b314526-40ef-4967-8921-230cb527ea65","request":{"method":"GET","header":[],"url":"{{url}}/patient_documents/{patient_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["patient_documents","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"239271a6-4e91-460c-80d6-c8590aebb05e","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_documents/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["patient_documents","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"419","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:47:33 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"500\",\"total_count\":\"1\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_documents\\/355203\",\"patient_id\":\"355203\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/355203\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"document_path\":\"\\\\\\\\Nt-fs1\\\\Share\\\\SoftDent\\\\PWImages\\\\Patient\\\\34\\\\5134\\\\C1.sc\"}]}]\r\n"}],"_postman_id":"2b314526-40ef-4967-8921-230cb527ea65"},{"name":"patient_existing_services","id":"3b079270-23d1-486f-bce8-4da4721d2a50","request":{"method":"GET","header":[],"url":"{{url}}/patient_existing_services?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system

","urlObject":{"path":["patient_existing_services"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"ed815993-3ee7-441b-bacb-858d4aafbd34","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_existing_services?request_key={{request_key}}","host":["{{url}}"],"path":["patient_existing_services"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"968","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:51:48 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"18862\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_existing_services\\/6063\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6063\"},\"patient_id\":\"6063\",\"procedure_code\":\"02140\",\"description\":\"AMALGAM-1 SURFACE\",\"completed_date\":\"2016-04-18\",\"surface\":\"O\",\"entered_date\":\"2016-04-18\",\"fee\":\"0.0000\",\"tooth\":\"3\",\"defective\":\"N\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_existing_services\\/6063\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6063\"},\"patient_id\":\"6063\",\"procedure_code\":\"02140\",\"description\":\"AMALGAM-1 SURFACE\",\"completed_date\":\"2016-04-18\",\"surface\":\"O\",\"entered_date\":\"2016-04-18\",\"fee\":\"0.0000\",\"tooth\":\"2\",\"defective\":\"N\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"3b079270-23d1-486f-bce8-4da4721d2a50"},{"name":"patient_existing_services by patient_id","id":"e10a84c2-a9d7-494a-a3b7-5963c2995555","request":{"method":"GET","header":[],"url":"{{url}}/patient_existing_services/{patient_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system

","urlObject":{"path":["patient_existing_services","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"e2af1d2d-53ad-47e2-a8df-d2b2bc6c86bd","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_existing_services/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["patient_existing_services","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"457","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:55:30 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_existing_services\\/6063\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6063\"},\"patient_id\":\"6063\",\"procedure_code\":\"02150\",\"description\":\"AMALGAM-2 SURFACES\",\"completed_date\":\"2016-04-18\",\"surface\":\"OB\",\"entered_date\":\"2016-04-18\",\"fee\":\"0.0000\",\"tooth\":\"31\",\"defective\":\"N\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"e10a84c2-a9d7-494a-a3b7-5963c2995555"},{"name":"patient_images","id":"63f08d80-35a3-490c-9a1e-6a7c0fdd7d30","request":{"method":"GET","header":[],"url":"{{url}}/patient_images?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system

","urlObject":{"path":["patient_images"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"f72f64c2-13ba-4c47-9bae-558d1061a135","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_images?request_key={{request_key}}","host":["{{url}}"],"path":["patient_images"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"929","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:57:51 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"2558\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_images\\/5803\",\"patient_id\":\"5803\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/5803\"},\"image_type\":\"patient image\",\"image_link\":\"http:\\/\\/centraldata.s3.amazonaws.com\\/images%2Fd1238%2F1%2F5803~63522.eop\",\"image_uploaded_time\":\"10\\/3\\/2014 2:19:29 PM\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_images\\/5803\",\"patient_id\":\"5803\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/5803\"},\"image_type\":\"patient image\",\"image_link\":\"http:\\/\\/centraldata.s3.amazonaws.com\\/images%2Fd1238%2F1%2F5803~63522.eop\",\"image_uploaded_time\":\"10\\/3\\/2014 9:53:47 AM\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"63f08d80-35a3-490c-9a1e-6a7c0fdd7d30"},{"name":"patient_images by patient_id","id":"de5efbb2-5dcf-4472-91a8-e90ca6617867","request":{"method":"GET","header":[],"url":"{{url}}/patient_images/{patient_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system

","urlObject":{"path":["patient_images","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"f4353859-4f11-4288-b30c-f19a9e0f8cd9","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_images/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["patient_images","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"435","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 10:00:22 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_images\\/5803\",\"patient_id\":\"5803\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/5803\"},\"image_type\":\"patient image\",\"image_link\":\"http:\\/\\/centraldata.s3.amazonaws.com\\/images%2Fd1238%2F1%2F5803~63522.eop\",\"image_uploaded_time\":\"10\\/3\\/2014 2:19:29 PM\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"de5efbb2-5dcf-4472-91a8-e90ca6617867"},{"name":"patient_statuses","id":"b2a710a7-f9a5-4c18-8438-495baf9d8b7b","request":{"method":"GET","header":[],"url":"{{url}}/patient_statuses?request_key={{request_key}}","description":"

Display the patient status used in practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID

","urlObject":{"path":["patient_statuses"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"03069991-d5b6-496c-a0e3-7630dd39b686","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_statuses?request_key={{request_key}}","host":["{{url}}"],"path":["patient_statuses"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"430","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 10:02:06 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"2\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_statuses\\/Inact\",\"status\":\"Inact\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_statuses\\/Active\",\"status\":\"Active\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"b2a710a7-f9a5-4c18-8438-495baf9d8b7b"},{"name":"patient_statuses by status","id":"de884b6b-ed6a-4626-8308-bf3a2b9d5559","request":{"method":"GET","header":[],"url":"{{url}}/patient_statuses/{status}?request_key={{request_key}}","description":"

Display the patient status used in practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID

","urlObject":{"path":["patient_statuses","{status}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"6abaef6f-9427-45e4-8615-49402df63a42","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_statuses/{status}?request_key={{request_key}}","host":["{{url}}"],"path":["patient_statuses","{status}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"186","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 10:04:02 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patient_statuses\\/Inact\",\"status\":\"Inact\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"de884b6b-ed6a-4626-8308-bf3a2b9d5559"},{"name":"patients_v2","id":"243cc2f5-7dde-4318-9ff6-ade0496c4944","request":{"method":"GET","header":[],"url":"{{url}}/patients_v2?request_key={{request_key}}","description":"

patients_v2 is same as patients API except ‘last_transaction_date’. ‘Last_transaction_date’ is additional field in ‘patients_v2’ API. This API has been introduced to improve ‘last_visit’ filter and return data based on ‘last_visit’ date. how 'last_visit' filter work : i.e for last_visit = 2016-09-28 filter last_visit= '2016-09-28' OR (last_visit= ' ' AND first_visit= '2016-09-28') OR last_transaction_date = '2016-09-28'

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
guarantor_id	Guarantor id as per practice management systems	No
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
last_visit	Last Visit	No
cell	Cell Number	No
search	Search patient by firstname , lastname , email , middlename, city, state, zipcode, homephone, workphone, cell	No
status	Status of patient	No
phone	Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["patients_v2"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"e788ee0f-6455-4ff9-b11e-bb946a2d6235","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patients_v2?request_key={{request_key}}","host":["{{url}}"],"path":["patients_v2"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"3734","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 05:57:04 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"5071\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6071\",\"patient_id\":\"6071\",\"guarantor_id\":\"5865\",\"firstname\":\"Wastde\",\"middlename\":\"\",\"lastname\":\"Kmade\",\"preferred_name\":\"\",\"salutation\":\"\",\"birthdate\":\"1926-12-26\",\"status\":\"Active\",\"patient_note\":\"\",\"medical_note\":\"\",\"alert_note\":\"\",\"other_note\":\"\",\"gender\":\"Male\",\"address_line1\":\"260ugdt\",\"address_line2\":\"\",\"city\":\"Peoria\",\"state\":\"IL\",\"zipcode\":\"61604\",\"homephone\":\"\",\"workphone\":\"\",\"cell\":\"\",\"email\":\"\",\"employer_id\":\"1082_282\",\"employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/1082_282\"},\"billing_type\":\"\",\"first_visit\":\"\",\"last_visit\":\"\",\"provider_id\":\"DR\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"appointments\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/appointments?patient_id=6071\"},\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/5865\"},\"primary_insurance_company_id\":\"1082\",\"primary_insurance_company\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_companies\\/1082\"},\"secondary_insurance_company_id\":\"\",\"primary_relationship\":\"Self\",\"country\":\"\",\"primary_medical_insurance\":\"\",\"primary_medical_insurance_id\":\"\",\"primary_medical_relationship\":\"\",\"primary_medical_subscriber_id\":\"\",\"secondary_medical_insurance\":\"\",\"secondary_medical_insurance_id\":\"\",\"secondary_medical_relationship\":\"\",\"secondary_medical_subscriber_id\":\"\",\"secondary_relationship\":\"\",\"subscriber_id\":\"\",\"patient_account_id\":\"\",\"other_referral\":\"\",\"patient_referral\":\"\",\"referred_out\":\"\",\"referred_by_provider_id\":\"\",\"referred_by_patient_id\":\"\",\"image\":\"\",\"thumb_image\":\"\",\"fee_no\":\"\",\"guarantor_first_name\":\"Mastde\",\"guarantor_last_name\":\"Kugdt\",\"last_transaction_date\":\"\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6070\",\"patient_id\":\"6070\",\"guarantor_id\":\"6070\",\"firstname\":\"Tastde\",\"middlename\":\"\",\"lastname\":\"Smade\",\"preferred_name\":\"\",\"salutation\":\"\",\"birthdate\":\"1967-06-20\",\"status\":\"Active\",\"patient_note\":\"\",\"medical_note\":\"\",\"alert_note\":\"\",\"other_note\":\"\",\"gender\":\"Male\",\"address_line1\":\"\",\"address_line2\":\"\",\"city\":\"Peoria\",\"state\":\"IL\",\"zipcode\":\"61614\",\"homephone\":\"\",\"workphone\":\"\",\"cell\":\"\",\"email\":\"\",\"employer_id\":\"1117_38\",\"employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/1117_38\"},\"billing_type\":\"\",\"first_visit\":\"\",\"last_visit\":\"\",\"provider_id\":\"DR\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"appointments\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/appointments?patient_id=6070\"},\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/6070\"},\"primary_insurance_company_id\":\"1117\",\"primary_insurance_company\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_companies\\/1117\"},\"secondary_insurance_company_id\":\"\",\"primary_relationship\":\"Self\",\"country\":\"\",\"primary_medical_insurance\":\"\",\"primary_medical_insurance_id\":\"\",\"primary_medical_relationship\":\"\",\"primary_medical_subscriber_id\":\"\",\"secondary_medical_insurance\":\"\",\"secondary_medical_insurance_id\":\"\",\"secondary_medical_relationship\":\"\",\"secondary_medical_subscriber_id\":\"\",\"secondary_relationship\":\"\",\"subscriber_id\":\"\",\"patient_account_id\":\"\",\"other_referral\":\"\",\"patient_referral\":\"\",\"referred_out\":\"\",\"referred_by_provider_id\":\"\",\"referred_by_patient_id\":\"\",\"image\":\"\",\"thumb_image\":\"\",\"fee_no\":\"\",\"guarantor_first_name\":\"Ttedda\",\"guarantor_last_name\":\"Sqode\",\"last_transaction_date\":\"\"}]}]\r\n"}],"_postman_id":"243cc2f5-7dde-4318-9ff6-ade0496c4944"},{"name":"patients_v2 by patient_id","id":"a83d3098-ff75-4c79-93cb-9c660c386df0","request":{"method":"GET","header":[],"url":"{{url}}/patients_v2/{patient_id}?request_key={{request_key}}","description":"

patients_v2 is same as patients API except ‘last_transaction_date’. ‘Last_transaction_date’ is additional field in ‘patients_v2’ API.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
email	Email id of patient / provider	No
guarantor_id	Guarantor id as per practice management systems	No
patient_id	Patient ID as per the management system	No
firstname	First name of patient, provider or guarantor	No
practice_id	Practice ID	No
lastname	Last name of patient, provider or guarantor	No
last_visit	Last Visit	No
phone	Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
firstname	First name of patient, provider or guarantor
lastname	Last name of patient, provider or guarantor
zipcode	Zipcode

","urlObject":{"path":["patients_v2","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"6721770e-a725-4989-b55e-5923cd85d702","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patients_v2/6071?request_key={{request_key}}","host":["{{url}}"],"path":["patients_v2","6071"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1842","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 06:42:26 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6071\",\"patient_id\":\"6071\",\"guarantor_id\":\"5865\",\"firstname\":\"Wastde\",\"middlename\":\"\",\"lastname\":\"Kmade\",\"preferred_name\":\"\",\"salutation\":\"\",\"birthdate\":\"1926-12-26\",\"status\":\"Active\",\"patient_note\":\"\",\"medical_note\":\"\",\"alert_note\":\"\",\"other_note\":\"\",\"gender\":\"Male\",\"address_line1\":\"260ugdt\",\"address_line2\":\"\",\"city\":\"Peoria\",\"state\":\"IL\",\"zipcode\":\"61604\",\"homephone\":\"\",\"workphone\":\"\",\"cell\":\"\",\"email\":\"\",\"employer_id\":\"1082_282\",\"employer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/employers\\/1082_282\"},\"billing_type\":\"\",\"first_visit\":\"\",\"last_visit\":\"\",\"provider_id\":\"DR\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"appointments\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/appointments?patient_id=6071\"},\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/5865\"},\"primary_insurance_company_id\":\"1082\",\"primary_insurance_company\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/insurance_companies\\/1082\"},\"secondary_insurance_company_id\":\"\",\"primary_relationship\":\"Self\",\"country\":\"\",\"primary_medical_insurance\":\"\",\"primary_medical_insurance_id\":\"\",\"primary_medical_relationship\":\"\",\"primary_medical_subscriber_id\":\"\",\"secondary_medical_insurance\":\"\",\"secondary_medical_insurance_id\":\"\",\"secondary_medical_relationship\":\"\",\"secondary_medical_subscriber_id\":\"\",\"secondary_relationship\":\"\",\"subscriber_id\":\"\",\"patient_account_id\":\"\",\"other_referral\":\"\",\"patient_referral\":\"\",\"referred_out\":\"\",\"referred_by_provider_id\":\"\",\"referred_by_patient_id\":\"\",\"image\":\"\",\"thumb_image\":\"\",\"fee_no\":\"\",\"guarantor_first_name\":\"Mastde\",\"guarantor_last_name\":\"Kugdt\",\"last_transaction_date\":\"\"}\r\n"}],"_postman_id":"a83d3098-ff75-4c79-93cb-9c660c386df0"},{"name":"perio_charts","id":"c9481a3a-290b-4ad1-a6aa-a8daf3df4560","request":{"method":"GET","header":[],"url":"{{url}}/perio_charts?request_key={{request_key}}","description":"

'perio_charts' return the numbers of periodontal chart extracted from practice management system. Dental charting is a process in which your dental healthcare professional lists and describes the health of patient's teeth and gums. The charting is usually done during dental checkups.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
date	Filter on date field, format: yyyy-mm-dd	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID
date	Filter on date field, format: yyyy-mm-dd

","urlObject":{"path":["perio_charts"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"a2a2e2cf-34d0-4780-9d22-18aeab973987","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/perio_charts?request_key={{request_key}}","host":["{{url}}"],"path":["perio_charts"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1707","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:07:09 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"16064\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/perio_charts\\/355201\",\"patient_id\":\"355201\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/355201\"},\"chart_date\":\"2017-03-20\",\"tooth_number\":\"1\",\"surface\":\"Upper\",\"pocket_depth_1\":\"2\",\"pocket_depth_2\":\"3\",\"pocket_depth_3\":\"2\",\"mucogingival_junction_1\":\"0\",\"mucogingival_junction_2\":\"0\",\"mucogingival_junction_3\":\"0\",\"bleed_1\":\"0\",\"bleed_2\":\"0\",\"bleed_3\":\"0\",\"suppuration_1\":\"0\",\"suppurtation_2\":\"0\",\"suppurtation_3\":\"0\",\"furcation_lingual_distal\":\"None\",\"furcation_lingual_mesial\":\"None\",\"furcation_lingual\":\"None\",\"furcation_facial\":\"None\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"free_gingival_margin_1\":\"0\",\"free_gingival_margin_2\":\"0\",\"free_gingival_margin_3\":\"0\",\"calculus\":\"\",\"plaque\":\"\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/perio_charts\\/355201\",\"patient_id\":\"355201\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/355201\"},\"chart_date\":\"2017-04-06\",\"tooth_number\":\"32\",\"surface\":\"Lower\",\"pocket_depth_1\":\"0\",\"pocket_depth_2\":\"0\",\"pocket_depth_3\":\"0\",\"mucogingival_junction_1\":\"0\",\"mucogingival_junction_2\":\"0\",\"mucogingival_junction_3\":\"0\",\"bleed_1\":\"0\",\"bleed_2\":\"0\",\"bleed_3\":\"0\",\"suppuration_1\":\"0\",\"suppurtation_2\":\"0\",\"suppurtation_3\":\"0\",\"furcation_lingual_distal\":\"\",\"furcation_lingual_mesial\":\"\",\"furcation_lingual\":\"None\",\"furcation_facial\":\"None\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"free_gingival_margin_1\":\"0\",\"free_gingival_margin_2\":\"0\",\"free_gingival_margin_3\":\"0\",\"calculus\":\"\",\"plaque\":\"\"}]}]\r\n"}],"_postman_id":"c9481a3a-290b-4ad1-a6aa-a8daf3df4560"},{"name":"perio_charts by patient_id","id":"556217ca-0d88-4ccd-afe6-a831414240f3","request":{"method":"GET","header":[],"url":"{{url}}/perio_charts/{patient_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
date	Filter on date field, format: yyyy-mm-dd	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID
date	Filter on date field, format: yyyy-mm-dd

","urlObject":{"path":["perio_charts","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"6cfa8390-9f53-4bbf-8faa-0fc0a331ed21","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/perio_charts/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["perio_charts","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"879","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:16:06 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"1\",\"total_count\":\"192\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/perio_charts\\/355201\",\"patient_id\":\"355201\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/355201\"},\"chart_date\":\"2017-04-06\",\"tooth_number\":\"32\",\"surface\":\"Lower\",\"pocket_depth_1\":\"0\",\"pocket_depth_2\":\"0\",\"pocket_depth_3\":\"0\",\"mucogingival_junction_1\":\"0\",\"mucogingival_junction_2\":\"0\",\"mucogingival_junction_3\":\"0\",\"bleed_1\":\"0\",\"bleed_2\":\"0\",\"bleed_3\":\"0\",\"suppuration_1\":\"0\",\"suppurtation_2\":\"0\",\"suppurtation_3\":\"0\",\"furcation_lingual_distal\":\"\",\"furcation_lingual_mesial\":\"\",\"furcation_lingual\":\"None\",\"furcation_facial\":\"None\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"free_gingival_margin_1\":\"0\",\"free_gingival_margin_2\":\"0\",\"free_gingival_margin_3\":\"0\",\"calculus\":\"\",\"plaque\":\"\"}]}]\r\n"}],"_postman_id":"556217ca-0d88-4ccd-afe6-a831414240f3"},{"name":"prescriptions","id":"7f2a0f07-337b-4685-accf-466b074e452b","request":{"method":"GET","header":[],"url":"{{url}}/prescriptions?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
procedure_code_id	Procedure code id is same as procedure code.	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
prescription_id	Prescription_id

","urlObject":{"path":["prescriptions"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"6b1d5373-f81e-4129-a762-265e7a9ad0ce","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/prescriptions?request_key={{request_key}}","host":["{{url}}"],"path":["prescriptions"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1171","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:24:56 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"1361\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/prescriptions\\/1369\",\"prescription_id\":\"1369\",\"patient_id\":\"5717\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/5717\"},\"provider_id\":\"DR\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"drug_id\":\"1\",\"drug\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/drugs\\/1\"},\"date\":\"2016-04-18\",\"quantity\":\"\",\"refills\":\"\",\"direction\":\"\",\"days\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/prescriptions\\/1368\",\"prescription_id\":\"1368\",\"patient_id\":\"2403\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/2403\"},\"provider_id\":\"DR\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"drug_id\":\"2\",\"drug\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/drugs\\/2\"},\"date\":\"2016-04-11\",\"quantity\":\"\",\"refills\":\"\",\"direction\":\"\",\"days\":\"0\"}]}]\r\n"}],"_postman_id":"7f2a0f07-337b-4685-accf-466b074e452b"},{"name":"prescriptions by prescription_id","id":"58d0db38-113e-4bc3-b98c-5823faeae787","request":{"method":"GET","header":[],"url":"{{url}}/prescriptions/{prescription_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
procedure_code_id	Procedure code id is same as procedure code.	No

** SortBy**

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
prescription_id	Prescription_id

","urlObject":{"path":["prescriptions","{prescription_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"e6659fa6-dc36-4cd4-8145-d1c2a2560391","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/prescriptions/{prescription_id}?request_key={{request_key}}","host":["{{url}}"],"path":["prescriptions","{prescription_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"615","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:27:27 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"500\",\"total_count\":\"1\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/prescriptions\\/1369\",\"prescription_id\":\"1369\",\"patient_id\":\"5717\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/5717\"},\"provider_id\":\"DR\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"drug_id\":\"1\",\"drug\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/drugs\\/1\"},\"date\":\"2016-04-18\",\"quantity\":\"\",\"refills\":\"\",\"direction\":\"\",\"days\":\"0\"}]}]\r\n"}],"_postman_id":"58d0db38-113e-4bc3-b98c-5823faeae787"},{"name":"reminders","id":"8e4031ac-941e-46ca-9fdd-519d36d2e1c5","request":{"method":"GET","header":[],"url":"{{url}}/reminders?request_key={{request_key}}","description":"

Display the information about reminders for patient , apppointment information ( if any appointment associate with reminder ) , description etc.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
guarantor_id	Guarantor id as per practice management systems	No
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
procedure_code	Procedure code as per practice management system	No

Sortby

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
id	valid id, coma separated for multiple

","urlObject":{"path":["reminders"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"c401497f-cdee-455b-8749-3c6218ba606e","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/reminders?request_key={{request_key}}","host":["{{url}}"],"path":["reminders"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1711","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:35:50 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"5071\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/reminders\\/1\",\"patient_id\":\"6071\",\"id\":\"1\",\"guarantor_id\":\"5865\",\"appointment_sr_no\":\"0\",\"set_date\":\"2016-04-20\",\"due_date\":\"\",\"prior_date\":\"\",\"provider_type\":\"0\",\"provider_id\":\"LW\",\"time_unit\":\"6\",\"status\":\"\",\"care_name\":\"Next Recall\",\"description\":\"Next Recall\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6071\"},\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/5865\"},\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/LW\"},\"appointment\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/appointments\\/0\"},\"interval_type\":\"Months\",\"interval_length\":\"6\",\"procedure_code\":\"\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/reminders\\/1\",\"patient_id\":\"1001\",\"id\":\"1\",\"guarantor_id\":\"1001\",\"appointment_sr_no\":\"0\",\"set_date\":\"2005-08-23\",\"due_date\":\"2016-08-24\",\"prior_date\":\"2013-05-08\",\"provider_type\":\"0\",\"provider_id\":\"DR\",\"time_unit\":\"6\",\"status\":\"\",\"care_name\":\"Next Recall\",\"description\":\"Next Recall\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/1001\"},\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/1001\"},\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"appointment\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/appointments\\/0\"},\"interval_type\":\"Months\",\"interval_length\":\"6\",\"procedure_code\":\"\"}]}]\r\n"}],"_postman_id":"8e4031ac-941e-46ca-9fdd-519d36d2e1c5"},{"name":"reminders by id","id":"62399ae4-d9ff-47dc-9be5-d91678114d44","request":{"method":"GET","header":[],"url":"{{url}}/reminders/{id}?request_key={{request_key}}","description":"

Reminder information based on id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
guarantor_id	Guarantor id as per practice management systems	No
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
procedure_code	Procedure code as per practice management system	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
id	valid id, coma separated for multiple

","urlObject":{"path":["reminders","{id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"a8a98613-bcf4-42fb-b93d-57fd1df9b4a8","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/reminders/{id}?request_key={{request_key}}","host":["{{url}}"],"path":["reminders","{id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"816","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:38:52 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/reminders\\/1\",\"patient_id\":\"6071\",\"id\":\"1\",\"guarantor_id\":\"5865\",\"appointment_sr_no\":\"0\",\"set_date\":\"2016-04-20\",\"due_date\":\"\",\"prior_date\":\"\",\"provider_type\":\"0\",\"provider_id\":\"LW\",\"time_unit\":\"6\",\"status\":\"\",\"care_name\":\"Next Recall\",\"description\":\"Next Recall\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6071\"},\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/5865\"},\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/LW\"},\"appointment\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/appointments\\/0\"},\"interval_type\":\"Months\",\"interval_length\":\"6\",\"procedure_code\":\"\"}\r\n"}],"_postman_id":"62399ae4-d9ff-47dc-9be5-d91678114d44"},{"name":"xrays","id":"54faa463-36ba-4139-9f83-01159d02b81e","request":{"method":"GET","header":[],"url":"{{url}}/xrays?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system

","urlObject":{"path":["xrays"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"d35b3a77-8b81-496a-bd2c-558c421ef2db","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/xrays?request_key={{request_key}}","host":["{{url}}"],"path":["xrays"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"521","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 09:40:53 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"2558\",\n \"items\": [\n {\n \"patient_id\": \"5803\",\n \"xray_link\": \"http://s3.amazonaws.com/centraldata/images%2Fd1238%2F1%2F5803~63522.eop?AWSAccessKeyId=0BPTN6K6J3BQ6GDPCD02&Expires=1493372454&Signature=Ui91Uj6vilW1MaRmQPM2%2BN\",\n \"practice_id\": \"1\"\n },\n {\n \"patient_id\": \"5803\",\n \"xray_link\": \"http://s3.amazonaws.com/centraldata/images%2Fd1238%2F1%2F5803~63522.eop?AWSAccessKeyId=0BPTN6K6J3BQ6GDPCD02&Expires=1493372454&Signature=Ui91Uj6vilW1MaRmQPM2%2BNH\",\n \"practice_id\": \"1\"\n }\n ]\n }\n]"}],"_postman_id":"54faa463-36ba-4139-9f83-01159d02b81e"},{"name":"xrays by patient_id","id":"b56ea04c-3d2f-49cb-9a97-58844b12f8cd","request":{"method":"GET","header":[],"url":"{{url}}/xrays/{patient_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system

","urlObject":{"path":["xrays","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"391dd7a8-95ec-4924-92c9-00592314d98e","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/xrays/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["xrays","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"231","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 09:42:40 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"patient_id\": \"5803\",\n \"xray_link\": \"http://s3.amazonaws.com/centraldata/images%2Fd1238%2F1%2F5803~63522.eop?AWSAccessKeyId=0BPTN6K6J3BQ6GDPCD02&Expires=1493372560&Signature=Xn9Ydzeji7zeMKjzF%2FwJsN\",\n \"practice_id\": \"1\"\n}"}],"_postman_id":"b56ea04c-3d2f-49cb-9a97-58844b12f8cd"},{"name":"transactions","id":"ea788a46-32d5-42f6-8287-fbfa20f951bd","request":{"method":"GET","header":[],"url":"{{url}}/transactions?request_key={{request_key}}","description":"

Get the collection of all transactions.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
guarantor_id	Guarantor id as per practice management systems	No
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
claim_sr_no	Claim serial number	No
startdate	format: yyyy-mm-dd, start date	No
enddate	format: yyyy-mm-dd, end date	No
procedure_code	Procedure code as per practice management system	No
transaction_type	Transaction Type	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
transaction_sr_no	Transaction serial number from Practice management System
transaction_date	Transaction Date

","urlObject":{"path":["transactions"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"c45433b2-63a8-4e69-8d46-42311726764b","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/transactions?request_key={{request_key}}","host":["{{url}}"],"path":["transactions"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"2542","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:49:33 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"534299\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/transactions\\/544688\",\"transaction_sr_no\":\"544688\",\"patient_id\":\"3369\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/3369\"},\"guarantor_id\":\"1215\",\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/1215\"},\"transaction_type\":\"Payment\",\"transaction_date\":\"2016-04-22\",\"transaction_entry_date\":\"2016-04-22\",\"procedure_code\":\"2\",\"procedure_description\":\"Check\",\"provider_id\":\"DR\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"amount\":\"0.0000\",\"tooth_from\":\"\",\"tooth_to\":\"\",\"estimated_insurance_payment\":\"148\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"invoice_number\":\"\",\"invoice_status\":\"\",\"invoice_item\":\"\",\"quantity\":\"\",\"claim_sr_no\":\"41014\",\"claim\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/claims\\/41014\"},\"pre_authorization_id\":\"\",\"payment_type\":\"Ins\",\"surface\":\"\",\"note\":\"for claim from 12\\/29\\/2015\",\"is_group_transaction\":\"\",\"cheque_no\":\"\",\"clinical_condition_id\":\"\",\"collection_provider_id\":\"\",\"created_by\":\"\",\"last_updated_by\":\"\",\"primary_insurance_estimate\":\"\",\"secondary_insurance_estimate\":\"\",\"surface_quadrant_type\":\"\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/transactions\\/544687\",\"transaction_sr_no\":\"544687\",\"patient_id\":\"4277\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/4277\"},\"guarantor_id\":\"4277\",\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/4277\"},\"transaction_type\":\"Payment\",\"transaction_date\":\"2016-04-22\",\"transaction_entry_date\":\"2016-04-22\",\"procedure_code\":\"2\",\"procedure_description\":\"Check\",\"provider_id\":\"DR\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"amount\":\"0.0000\",\"tooth_from\":\"\",\"tooth_to\":\"\",\"estimated_insurance_payment\":\"0\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"invoice_number\":\"\",\"invoice_status\":\"\",\"invoice_item\":\"\",\"quantity\":\"\",\"claim_sr_no\":\"40709\",\"claim\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/claims\\/40709\"},\"pre_authorization_id\":\"\",\"payment_type\":\"Ins\",\"surface\":\"\",\"note\":\"for claim from 11\\/4\\/2015\",\"is_group_transaction\":\"\",\"cheque_no\":\"\",\"clinical_condition_id\":\"\",\"collection_provider_id\":\"\",\"created_by\":\"\",\"last_updated_by\":\"\",\"primary_insurance_estimate\":\"\",\"secondary_insurance_estimate\":\"\",\"surface_quadrant_type\":\"\"}]}]\r\n"}],"_postman_id":"ea788a46-32d5-42f6-8287-fbfa20f951bd"},{"name":"transactions by transaction_sr_no","id":"50876a31-2a7f-4614-b38a-f41df869e92f","request":{"method":"GET","header":[],"url":"{{url}}/transactions/{transaction_sr_no}?request_key={{request_key}}","description":"

Get the information about transaction based on transaction serial number. It will return transaction date , type ,amount , patient id , description etc.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
guarantor_id	Guarantor id as per practice management systems	No
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
claim_sr_no	Claim serial number	No
startdate	format: yyyy-mm-dd, start date	No
enddate	format: yyyy-mm-dd, end date	No
procedure_code	Procedure code as per practice management system	No
transaction_type	Transaction Type	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
transaction_sr_no	Transaction serial number from Practice management System
transaction_date	Transaction Date

","urlObject":{"path":["transactions","{transaction_sr_no}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"d7077808-a472-4f38-ad55-ef2c72bb77cc","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/transactions/{transaction_sr_no}?request_key={{request_key}}","host":["{{url}}"],"path":["transactions","{transaction_sr_no}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1242","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:55:04 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/transactions\\/544688\",\"transaction_sr_no\":\"544688\",\"patient_id\":\"3369\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/3369\"},\"guarantor_id\":\"1215\",\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/1215\"},\"transaction_type\":\"Payment\",\"transaction_date\":\"2016-04-22\",\"transaction_entry_date\":\"2016-04-22\",\"procedure_code\":\"2\",\"procedure_description\":\"Check\",\"provider_id\":\"DR\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"amount\":\"0.0000\",\"tooth_from\":\"\",\"tooth_to\":\"\",\"estimated_insurance_payment\":\"148\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"invoice_number\":\"\",\"invoice_status\":\"\",\"invoice_item\":\"\",\"quantity\":\"\",\"claim_sr_no\":\"41014\",\"claim\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/claims\\/41014\"},\"pre_authorization_id\":\"\",\"payment_type\":\"Ins\",\"surface\":\"\",\"note\":\"for claim from 12\\/29\\/2015\",\"is_group_transaction\":\"\",\"cheque_no\":\"\",\"clinical_condition_id\":\"\",\"collection_provider_id\":\"\",\"created_by\":\"\",\"last_updated_by\":\"\",\"primary_insurance_estimate\":\"\",\"secondary_insurance_estimate\":\"\",\"surface_quadrant_type\":\"\"}\r\n"}],"_postman_id":"50876a31-2a7f-4614-b38a-f41df869e92f"},{"name":"treatment_plans","id":"c80c5da9-50a6-47a8-a8ff-179a32eeb727","request":{"method":"GET","header":[],"url":"{{url}}/treatment_plans?request_key={{request_key}}","description":"

Get the full collection of all the treatment plans scheduled in practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
guarantor_id	Guarantor id as per practice management systems	No
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
procedure_code	Procedure code as per practice management system	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
treatment_plan_sr_no	Treatment plan serial number from Practice management System
amount	Amount
procedure_date	Procedure Date
entry_date	Entry Date

","urlObject":{"path":["treatment_plans"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"4bab3bc2-8773-4bf4-ad41-6dcd319cd459","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/treatment_plans?request_key={{request_key}}","host":["{{url}}"],"path":["treatment_plans"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1948","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 09:03:03 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"65957\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/treatment_plans\\/999956215\",\"plan_sr_no\":\"999956215\",\"patient_id\":\"3090\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/3090\"},\"guarantor_id\":\"3090\",\"procedure_code\":\"01110\",\"description\":\"CLEANING-(ROUTINE) AGE 12 & OVER\",\"provider_id\":\"LAF\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/LAF\"},\"amount\":\"94.0000\",\"entry_date\":\"2015-12-29\",\"insurance_payment\":\"0\",\"treatment_plan_status\":\"Completed\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/3090\"},\"procedure_date\":\"2015-08-26\",\"tooth_from\":\"\",\"tooth_to\":\"\",\"surface\":\"\",\"clinical_condition_id\":\"\",\"collection_provider_id\":\"\",\"created_by\":\"\",\"last_updated_by\":\"\",\"primary_insurance_estimate\":\"\",\"secondary_insurance_estimate\":\"\",\"surface_quadrant_type\":\"\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/treatment_plans\\/999925494\",\"plan_sr_no\":\"999925494\",\"patient_id\":\"3421\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/3421\"},\"guarantor_id\":\"3421\",\"procedure_code\":\"OHI\",\"description\":\"ORAL HYGIENE INSTRUCTIONS\",\"provider_id\":\"DR\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/DR\"},\"amount\":\"0.0000\",\"entry_date\":\"2015-03-17\",\"insurance_payment\":\"0\",\"treatment_plan_status\":\"Completed\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/3421\"},\"procedure_date\":\"2015-01-08\",\"tooth_from\":\"\",\"tooth_to\":\"\",\"surface\":\"\",\"clinical_condition_id\":\"\",\"collection_provider_id\":\"\",\"created_by\":\"\",\"last_updated_by\":\"\",\"primary_insurance_estimate\":\"\",\"secondary_insurance_estimate\":\"\",\"surface_quadrant_type\":\"\"}]}]\r\n"}],"_postman_id":"c80c5da9-50a6-47a8-a8ff-179a32eeb727"},{"name":"treatment_plans by treatment_plan_sr_no","id":"d007333b-6211-4046-abf7-79a4b544053e","request":{"method":"GET","header":[],"url":"{{url}}/treatment_plans/{treatment_plan_sr_no}?request_key={{request_key}}","description":"

Get the information about treatment plan as per plan serial number. Like patient id , guarantor id,provider id,amount , entry date , procedure date etc.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
guarantor_id	Guarantor id as per practice management systems	No
provider_id	Provider id as per practice management system	No
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
procedure_code	Procedure code as per practice management system	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
treatment_plan_sr_no	Treatment plan serial number from Practice management System
amount	Amount
procedure_date	Procedure Date
entry_date	Entry Date

","urlObject":{"path":["treatment_plans","{treatment_plan_sr_no}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"d443324b-ae8e-4033-a5fe-d83f17a083fd","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/treatment_plans/{treatment_plan_sr_no}?request_key={{request_key}}","host":["{{url}}"],"path":["treatment_plans","{treatment_plan_sr_no}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"950","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 09:08:08 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/treatment_plans\\/999956215\",\"plan_sr_no\":\"999956215\",\"patient_id\":\"3090\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/3090\"},\"guarantor_id\":\"3090\",\"procedure_code\":\"01110\",\"description\":\"CLEANING-(ROUTINE) AGE 12 & OVER\",\"provider_id\":\"LAF\",\"provider\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/providers\\/LAF\"},\"amount\":\"94.0000\",\"entry_date\":\"2015-12-29\",\"insurance_payment\":\"0\",\"treatment_plan_status\":\"Completed\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"guarantor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/guarantors\\/3090\"},\"procedure_date\":\"2015-08-26\",\"tooth_from\":\"\",\"tooth_to\":\"\",\"surface\":\"\",\"clinical_condition_id\":\"\",\"collection_provider_id\":\"\",\"created_by\":\"\",\"last_updated_by\":\"\",\"primary_insurance_estimate\":\"\",\"secondary_insurance_estimate\":\"\",\"surface_quadrant_type\":\"\"}\r\n"}],"_postman_id":"d007333b-6211-4046-abf7-79a4b544053e"},{"name":"treatment_plan_statuses","id":"b354b4f0-3a14-4051-8edc-eb3fa873971b","request":{"method":"GET","header":[],"url":"{{url}}/treatment_plan_statuses?request_key={{request_key}}","description":"

Get the list of all treatment plan status exist in practice management system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID

","urlObject":{"path":["treatment_plan_statuses"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"538a6bf1-98bc-485f-91d4-a0fa53984184","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/treatment_plan_statuses?request_key={{request_key}}","host":["{{url}}"],"path":["treatment_plan_statuses"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"438","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:57:20 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"7\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/treatment_plan_statuses\\/\",\"status\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/treatment_plan_statuses\\/Proposed\",\"status\":\"Proposed\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"b354b4f0-3a14-4051-8edc-eb3fa873971b"},{"name":"treatment_plan_statuses by status","id":"97a6a42f-82cd-4830-88e4-8d5dcb0126f3","request":{"method":"GET","header":[],"url":"{{url}}/treatment_plan_statuses/{status}?request_key={{request_key}}","description":"

Get the resource of treatment plan status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID

","urlObject":{"path":["treatment_plan_statuses","{status}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"591b1360-78ca-480b-bc6b-65672cd5aef4","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/treatment_plan_statuses/{status}?request_key={{request_key}}","host":["{{url}}"],"path":["treatment_plan_statuses","{status}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"199","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:59:11 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/treatment_plan_statuses\\/Proposed\",\"status\":\"Proposed\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"97a6a42f-82cd-4830-88e4-8d5dcb0126f3"},{"name":"medical_notes","id":"3a5668a8-d637-4663-a1a0-deabca676096","request":{"method":"GET","header":[],"url":"{{url}}/medical_notes?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system

","urlObject":{"path":["medical_notes"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"00ec5318-2544-40ac-a0ce-e47f13dc0286","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/medical_notes?request_key={{request_key}}","host":["{{url}}"],"path":["medical_notes"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private,max-age=86400","description":""},{"name":"Content-Encoding","key":"Content-Encoding","value":"gzip","description":""},{"name":"Content-Length","key":"Content-Length","value":"524","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 18 May 2017 06:29:57 GMT","description":""},{"name":"Expires","key":"Expires","value":"Wed, 01 Jan 1997 12:00:00 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"Vary","key":"Vary","value":"Accept-Encoding","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"500\",\"total_count\":\"3\",\"items\":[{\"href\":\"\",\"patient_id\":\"445501\",\"patient\":{\"href\":\"https:\\/\\/qaapi.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/445501\"},\"type\":\"PatNote\",\"date\":\"2016-01-01\",\"text\":\"Check gums on next visit\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/qaapi.sikkasoft.com\\/v2\\/practices\\/1\"},\"description\":\"\",\"provider_id\":\"\",\"procedure_date\":\"\",\"transaction_sr_no\":\"0\",\"transaction\":{\"href\":\"https:\\/\\/qaapi.sikkasoft.com\\/v2\\/practices\\/1\\/transactions\\/0\"},\"procedure_code_id\":\"\",\"clinical_condition_id\":\"\",\"tooth_number\":\"\",\"surface\":\"\"},{\"href\":\"\",\"patient_id\":\"111001\",\"patient\":{\"href\":\"https:\\/\\/qaapi.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/111001\"},\"type\":\"PatNote\",\"date\":\"2016-01-01\",\"text\":\"Xrays were normal\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/qaapi.sikkasoft.com\\/v2\\/practices\\/1\"},\"description\":\"\",\"provider_id\":\"\",\"procedure_date\":\"\",\"transaction_sr_no\":\"0\",\"transaction\":{\"href\":\"https:\\/\\/qaapi.sikkasoft.com\\/v2\\/practices\\/1\\/transactions\\/0\"},\"procedure_code_id\":\"\",\"clinical_condition_id\":\"\",\"tooth_number\":\"\",\"surface\":\"\"},{\"href\":\"\",\"patient_id\":\"111001\",\"patient\":{\"href\":\"https:\\/\\/qaapi.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/111001\"},\"type\":\"PatNote\",\"date\":\"2016-02-02\",\"text\":\"Check gums on next visit\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/qaapi.sikkasoft.com\\/v2\\/practices\\/1\"},\"description\":\"\",\"provider_id\":\"\",\"procedure_date\":\"\",\"transaction_sr_no\":\"0\",\"transaction\":{\"href\":\"https:\\/\\/qaapi.sikkasoft.com\\/v2\\/practices\\/1\\/transactions\\/0\"},\"procedure_code_id\":\"\",\"clinical_condition_id\":\"\",\"tooth_number\":\"\",\"surface\":\"\"}]}]\r\n"},{"id":"ec941030-f9e4-4339-9bce-843c9bbb8a68","name":"sample response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/medical_notes?request_key={{request_key}}","host":["{{url}}"],"path":["medical_notes"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1272","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 12:14:33 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"215110\",\"items\":[{\"href\":\"\",\"patient_id\":\"6066\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6066\"},\"type\":\"General Note\",\"date\":\"2016-04-19\",\"text\":\"DOS4-19-16Pt presents to the office as a new patient.Took 2 PAS #15Reviewed medical history with patient.Completed new patient interview.Took new patient photo.Dr Mathes performed comprehensive exam- completed dental chart perio chart and took intra oral pictures. Treatment plan established today for start with referral to DR. Dale for #15 and then crown?? Pt. needs a comprehensive treatment plan soon has extra insurance for 1 month so needs to get the higher priced treatment now. Dr. to give to Kim so she can give to Melissa.NV:Refer to Dr. Dale for #15LW\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"description\":\"\"},{\"href\":\"\",\"patient_id\":\"6066\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/6066\"},\"type\":\"Primary Insurace Note\",\"date\":\"2016-04-19\",\"text\":\"Insurance Claim from April 19 2016 was Submitted to Prim. Insurance Company: CIGNA Payer ID: 62308\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"description\":\"\"}]}]\r\n"}],"_postman_id":"3a5668a8-d637-4663-a1a0-deabca676096"},{"name":"medical_notes/medical_note","id":"ad51566b-9088-4bc9-a311-db6902c38711","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"}],"body":{"mode":"raw","raw":"{\r\n \"request_key\": \"b73ae58003bb686a38be06db529a894e\",\r\n \"medical_notes\": [{\r\n \"patient_id\": \"1\",\r\n \"type\": \"\",\r\n \"date\": \"2016-12-02\",\r\n \"text\": \"test text\",\r\n \"practice_id\": \"1\",\r\n \"provider_id\": \"1\",\r\n \"description\": \"\"\r\n }, {\r\n \"patient_id\": \"2\",\r\n \"type\": \"\",\r\n \"date\": \"2016-12-02\",\r\n \"text\": \"test text 2\",\r\n \"practice_id\": \"1\",\r\n \"provider_id\": \"1\",\r\n \"description\": \"\"\r\n }]\r\n}"},"url":"{{url}}/medical_notes/medical_note","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
provider_id	Provider id as per practice management system	Yes
patient_id	Patient ID as per the management system	Yes
practice_id	Practice ID	Yes
date	Filter on date field, format: yyyy-mm-dd	Yes
type	type	No
text	Text	Yes
description	Description	No

","urlObject":{"path":["medical_notes","medical_note"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"50c44733-95a1-44e3-9d4c-35f8ba938b58","name":"request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","type":"text","warning":""}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/medical_notes/medical_note"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"163","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 08:53:11 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"http_code\":\"201\",\"http_code_desc\":\"Created\",\"error_code\":\"API2016\",\"short_message\":\"New resource created successfully\",\"long_message\":\"\",\"more_information\":\"\"}\r\n"}],"_postman_id":"ad51566b-9088-4bc9-a311-db6902c38711"},{"name":"medical_history","id":"dbc251a1-22d1-44b7-ab25-34851db958c0","request":{"method":"GET","header":[],"url":"{{url}}/medical_history?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system

","urlObject":{"path":["medical_history"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"e88566df-cc84-4ec1-8a77-29ddc091f142","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/medical_history?request_key={{request_key}}","host":["{{url}}"],"path":["medical_history"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"888","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 12:03:40 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"228960\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/medical_history\\/355301\",\"patient_id\":\"355301\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/355301\"},\"type\":\"Allergy\",\"name\":\"Metals\",\"value\":\"Inactive\",\"description\":\"\",\"created_date\":\"2016-12-27\",\"updated_date\":\"2016-12-30\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/medical_history\\/355301\",\"patient_id\":\"355301\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/355301\"},\"type\":\"Medicaid\",\"name\":\"Amoxicillin 500 mg\",\"value\":\"62\",\"description\":\"Medicine ID & Name\",\"created_date\":\"2016-12-27\",\"updated_date\":\"2016-12-30\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"dbc251a1-22d1-44b7-ab25-34851db958c0"},{"name":"medical_history by patient_id","id":"0c3d282d-706c-437e-a33c-2d4f31c51b32","request":{"method":"GET","header":[],"url":"{{url}}/medical_history/{patient_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system

","urlObject":{"path":["medical_history","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"f40a622e-1079-4819-9935-5a559fc2b91d","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/medical_history/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["medical_history","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"459","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 12:07:27 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"1\",\"total_count\":\"20\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/medical_history\\/355301\",\"patient_id\":\"355301\",\"patient\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/patients\\/355301\"},\"type\":\"Allergy\",\"name\":\"Metals\",\"value\":\"Inactive\",\"description\":\"\",\"created_date\":\"2016-12-27\",\"updated_date\":\"2016-12-30\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"0c3d282d-706c-437e-a33c-2d4f31c51b32"},{"name":"animal_vital_signs","id":"9f380d6f-6c42-494b-a8b4-027898800f6a","request":{"method":"GET","header":[],"url":"{{url}}/animal_vital_signs?request_key={{request_key}}","description":"

API returns animal's vital signs , name , status and comments from practice management systems , if it is available.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
date	Filter on date field, format: yyyy-mm-dd	No
vital_sign_name	Vital sign name	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
date	Sorting on date field, format: yyyy-mm-dd
patient_id	Patient ID as per the management system
practice_id	Practice ID as per the management system

","urlObject":{"path":["animal_vital_signs"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"5bd1e7e0-1421-432b-baa7-d660c2bb7fbb","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/animal_vital_signs?request_key={{request_key}}","host":["{{url}}"],"path":["animal_vital_signs"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"888","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 12:03:40 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\r\n\t\"offset\": \"0\",\r\n\t\"limit\": \"2\",\r\n\t\"total_count\": \"505\",\r\n\t\"execution_time\": \"32\",\r\n\t\"items\": [{\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-1/animal_vital_signs/15331\",\r\n\t\t\"patient_id\": \"15331\",\r\n\t\t\"patient\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-1/patients/15331\"\r\n\t\t},\r\n\t\t\"date\": \"2012-09-28 13:36:00\",\r\n\t\t\"vital_sign_name\": \"Weight\",\r\n\t\t\"vital_sign_value\": \"63 pounds\",\r\n\t\t\"vital_sign_status\": \"Normal\",\r\n\t\t\"comments\": \"\",\r\n\t\t\"practice_id\": \"1-1\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-1/practices\"\r\n\t\t}\r\n\t}, {\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-1/animal_vital_signs/15331\",\r\n\t\t\"patient_id\": \"15331\",\r\n\t\t\"patient\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-1/patients/15331\"\r\n\t\t},\r\n\t\t\"date\": \"2012-09-28 13:36:00\",\r\n\t\t\"vital_sign_name\": \"Body Score (1-5)\",\r\n\t\t\"vital_sign_value\": \"3 - Optimal\",\r\n\t\t\"vital_sign_status\": \"Normal\",\r\n\t\t\"comments\": \"\",\r\n\t\t\"practice_id\": \"1-1\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-1/practices\"\r\n\t\t}\r\n\t}]\r\n}]"}],"_postman_id":"9f380d6f-6c42-494b-a8b4-027898800f6a"},{"name":"animal_vital_signs by patient_id","id":"bb6426db-976d-47d5-9b6c-2df6de574f1a","request":{"method":"GET","header":[],"url":"{{url}}/animal_vital_signs/{patient_id}?request_key={{request_key}}","description":"

API returns animal's vital signs , name , status and comments from practice management systems , if it is available.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
date	Filter on date field, format: yyyy-mm-dd	No
vital_sign_name	Vital sign name	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
date	Sorting on date field, format: yyyy-mm-dd
patient_id	Patient ID as per the management system
practice_id	Practice ID as per the management system

","urlObject":{"path":["animal_vital_signs","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"28957121-6df5-4ed7-b654-9487512a57f5","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/animal_vital_signs/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["animal_vital_signs","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"888","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 12:03:40 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\r\n\t\"offset\": \"0\",\r\n\t\"limit\": \"500\",\r\n\t\"total_count\": \"2\",\r\n\t\"execution_time\": \"44\",\r\n\t\"items\": [{\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-1/animal_vital_signs/15331\",\r\n\t\t\"patient_id\": \"15331\",\r\n\t\t\"patient\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-1/patients/15331\"\r\n\t\t},\r\n\t\t\"date\": \"2012-09-28 13:36:00\",\r\n\t\t\"vital_sign_name\": \"Weight\",\r\n\t\t\"vital_sign_value\": \"63 pounds\",\r\n\t\t\"vital_sign_status\": \"Normal\",\r\n\t\t\"comments\": \"\",\r\n\t\t\"practice_id\": \"1-1\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-1/practices\"\r\n\t\t}\r\n\t}, {\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-1/animal_vital_signs/15331\",\r\n\t\t\"patient_id\": \"15331\",\r\n\t\t\"patient\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-1/patients/15331\"\r\n\t\t},\r\n\t\t\"date\": \"2012-09-28 13:36:00\",\r\n\t\t\"vital_sign_name\": \"Body Score (1-5)\",\r\n\t\t\"vital_sign_value\": \"3 - Optimal\",\r\n\t\t\"vital_sign_status\": \"Normal\",\r\n\t\t\"comments\": \"\",\r\n\t\t\"practice_id\": \"1-1\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1-1/practices\"\r\n\t\t}\r\n\t}]\r\n}]"}],"_postman_id":"bb6426db-976d-47d5-9b6c-2df6de574f1a"},{"name":"pet_documents","id":"3e4fc493-68f9-4d9a-887c-80639cf23b46","request":{"method":"GET","header":[],"url":"{{url}}/pet_documents?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["pet_documents"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"97f95372-4847-4052-bb80-170d2f92f85e","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/pet_documents?request_key={{request_key}}","host":["{{url}}"],"path":["pet_documents"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"822","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:45:32 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\r\n\t\"offset\": \"0\",\r\n\t\"limit\": \"2\",\r\n\t\"total_count\": \"5398\",\r\n\t\"items\": [{\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1/pet_documents/4886\",\r\n\t\t\"patient_id\": \"4886\",\r\n\t\t\"patient\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1/patients/4886\"\r\n\t\t},\r\n\t\t\"practice_id\": \"1\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1\"\r\n\t\t},\r\n\t\t\"document_link\": \"http://s3.amazonaws.com/pet_documents_test1.pdf\"\r\n\t}, {\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1/pet_documents/4886\",\r\n\t\t\"patient_id\": \"4886\",\r\n\t\t\"patient\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1/patients/4886\"\r\n\t\t},\r\n\t\t\"practice_id\": \"1\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1\"\r\n\t\t},\r\n\t\t\"document_link\": \"http://s3.amazonaws.com/pet_documents_test2.pdf\"\r\n\t}]\r\n}]"}],"_postman_id":"3e4fc493-68f9-4d9a-887c-80639cf23b46"},{"name":"pet_documents by patient_id","id":"6abf80d7-4908-4395-b6ac-75bc4729f8d6","request":{"method":"GET","header":[],"url":"{{url}}/pet_documents/{patient_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["pet_documents","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"d75c70fc-58e6-4275-bb49-18e85536eb43","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/patient_documents/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["patient_documents","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"419","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:47:33 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\r\n\t\"offset\": \"0\",\r\n\t\"limit\": \"500\",\r\n\t\"total_count\": \"2\",\r\n\t\"items\": [{\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1/pet_documents/4886\",\r\n\t\t\"patient_id\": \"4886\",\r\n\t\t\"patient\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1/patients/4886\"\r\n\t\t},\r\n\t\t\"practice_id\": \"1\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1\"\r\n\t\t},\r\n\t\t\"document_link\": \"http://s3.amazonaws.com/pet_documents_test1.pdf\"\r\n\t}, {\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1/pet_documents/4886\",\r\n\t\t\"patient_id\": \"4886\",\r\n\t\t\"patient\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1/patients/4886\"\r\n\t\t},\r\n\t\t\"practice_id\": \"1\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/1\"\r\n\t\t},\r\n\t\t\"document_link\": \"http://s3.amazonaws.com/pet_documents_test2.pdf\"\r\n\t}]\r\n}]"}],"_postman_id":"6abf80d7-4908-4395-b6ac-75bc4729f8d6"},{"name":"many_guarantors_one_patient","id":"7bc5c8a4-1aa5-4527-842a-57d0ff337829","request":{"method":"GET","header":[],"url":"{{url}}/many_guarantors_one_patient?request_key={{request_key}}","description":"

Get all guarantors related to patients

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
guarantor_id	Guarantor id as per practice management systems	No
firstname	First name of patient, provider or guarantor	No
lastname	Last name of patient, provider or guarantor	No
cell	Cell Number	No
phone	Phone Number	No
workphone	Work Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["many_guarantors_one_patient"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"e08c595d-9aa6-4031-89ee-115d56ce773f","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/many_guarantors_one_patient?request_key={{request_key}}","host":["{{url}}"],"path":["many_guarantors_one_patient"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"822","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:45:32 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\r\n\t\"offset\": \"0\",\r\n\t\"limit\": \"500\",\r\n\t\"total_count\": \"2\",\r\n\t\"execution_time\": \"8191\",\r\n\t\"items\": [{\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/2/many_guarantors_one_patient/22222\",\r\n\t\t\"guarantor_id\": \"44444\",\r\n\t\t\"patient_id\": \"22222\",\r\n\t\t\"patient\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/2/patients/22222\"\r\n\t\t},\r\n\t\t\"firstname\": \"Male_Fname\",\r\n\t\t\"middlename\": \"\",\r\n\t\t\"lastname\": \"Test\",\r\n\t\t\"salutation\": \"Ms.\",\r\n\t\t\"ext\": \"\",\r\n\t\t\"gender\": \"Male\",\r\n\t\t\"marital_status\": \"\",\r\n\t\t\"birthdate\": \"1111-11-11\",\r\n\t\t\"address_line1\": \"Test St. Line 1\",\r\n\t\t\"address_line2\": \"Line 2 Of Address\",\r\n\t\t\"city\": \"San Jose\",\r\n\t\t\"state\": \"CA\",\r\n\t\t\"zipcode\": \"95110\",\r\n\t\t\"country\": \"\",\r\n\t\t\"phone\": \"(408) 659-8395\",\r\n\t\t\"workphone\": \"\",\r\n\t\t\"fax\": \"\",\r\n\t\t\"otherphone\": \"\",\r\n\t\t\"email\": \"\",\r\n\t\t\"cell\": \"\",\r\n\t\t\"practice_id\": \"2\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/2\"\r\n\t\t},\r\n\t\t\"relationship\": \"Mother\"\r\n\t}, {\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/2/many_guarantors_one_patient/22222\",\r\n\t\t\"guarantor_id\": \"55555\",\r\n\t\t\"patient_id\": \"22222\",\r\n\t\t\"patient\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/2/patients/22222\"\r\n\t\t},\r\n\t\t\"firstname\": \"Male_Fname_API\",\r\n\t\t\"middlename\": \"\",\r\n\t\t\"lastname\": \"Test\",\r\n\t\t\"salutation\": \"Mr.\",\r\n\t\t\"ext\": \"\",\r\n\t\t\"gender\": \"Male\",\r\n\t\t\"marital_status\": \"\",\r\n\t\t\"birthdate\": \"1111-11-11\",\r\n\t\t\"address_line1\": \"Test St. Line 1\",\r\n\t\t\"address_line2\": \"Line 2 Of Address\",\r\n\t\t\"city\": \"San Jose\",\r\n\t\t\"state\": \"CA\",\r\n\t\t\"zipcode\": \"95110\",\r\n\t\t\"country\": \"\",\r\n\t\t\"phone\": \"\",\r\n\t\t\"workphone\": \"\",\r\n\t\t\"fax\": \"\",\r\n\t\t\"otherphone\": \"\",\r\n\t\t\"email\": \"\",\r\n\t\t\"cell\": \"\",\r\n\t\t\"practice_id\": \"2\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/2\"\r\n\t\t},\r\n\t\t\"relationship\": \"(Unknown)\"\r\n\t}]\r\n}]"}],"_postman_id":"7bc5c8a4-1aa5-4527-842a-57d0ff337829"},{"name":"many_guarantors_one_patient by patient_id","id":"ed05edec-76c3-435a-b29a-d200fdacdb38","request":{"method":"GET","header":[],"url":"{{url}}/many_guarantors_one_patient/{patient_id}?request_key={{request_key}}","description":"

Get all guarantors related to patient_id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
patient_id	Patient ID as per the management system	No
practice_id	Practice ID	No
guarantor_id	Guarantor id as per practice management systems	No
firstname	First name of patient, provider or guarantor	No
lastname	Last name of patient, provider or guarantor	No
cell	Cell Number	No
phone	Phone Number	No
workphone	Work Phone Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
patient_id	Patient ID as per the management system
practice_id	Practice ID

","urlObject":{"path":["many_guarantors_one_patient","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"59d0b05f-9fe3-445c-94d0-8079cb0f94b1","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/many_guarantors_one_patient/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["many_guarantors_one_patient","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[{\r\n\t\"offset\": \"0\",\r\n\t\"limit\": \"500\",\r\n\t\"total_count\": \"2\",\r\n\t\"execution_time\": \"8191\",\r\n\t\"items\": [{\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/2/many_guarantors_one_patient/22222\",\r\n\t\t\"guarantor_id\": \"44444\",\r\n\t\t\"patient_id\": \"22222\",\r\n\t\t\"patient\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/2/patients/22222\"\r\n\t\t},\r\n\t\t\"firstname\": \"Male_Fname\",\r\n\t\t\"middlename\": \"\",\r\n\t\t\"lastname\": \"Test\",\r\n\t\t\"salutation\": \"Ms.\",\r\n\t\t\"ext\": \"\",\r\n\t\t\"gender\": \"Male\",\r\n\t\t\"marital_status\": \"\",\r\n\t\t\"birthdate\": \"1111-11-11\",\r\n\t\t\"address_line1\": \"Test St. Line 1\",\r\n\t\t\"address_line2\": \"Line 2 Of Address\",\r\n\t\t\"city\": \"San Jose\",\r\n\t\t\"state\": \"CA\",\r\n\t\t\"zipcode\": \"95110\",\r\n\t\t\"country\": \"\",\r\n\t\t\"phone\": \"(408) 659-8395\",\r\n\t\t\"workphone\": \"\",\r\n\t\t\"fax\": \"\",\r\n\t\t\"otherphone\": \"\",\r\n\t\t\"email\": \"\",\r\n\t\t\"cell\": \"\",\r\n\t\t\"practice_id\": \"2\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/2\"\r\n\t\t},\r\n\t\t\"relationship\": \"Mother\"\r\n\t}, {\r\n\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/2/many_guarantors_one_patient/22222\",\r\n\t\t\"guarantor_id\": \"55555\",\r\n\t\t\"patient_id\": \"22222\",\r\n\t\t\"patient\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/2/patients/22222\"\r\n\t\t},\r\n\t\t\"firstname\": \"Male_Fname_API\",\r\n\t\t\"middlename\": \"\",\r\n\t\t\"lastname\": \"Test\",\r\n\t\t\"salutation\": \"Mr.\",\r\n\t\t\"ext\": \"\",\r\n\t\t\"gender\": \"Male\",\r\n\t\t\"marital_status\": \"\",\r\n\t\t\"birthdate\": \"1111-11-11\",\r\n\t\t\"address_line1\": \"Test St. Line 1\",\r\n\t\t\"address_line2\": \"Line 2 Of Address\",\r\n\t\t\"city\": \"San Jose\",\r\n\t\t\"state\": \"CA\",\r\n\t\t\"zipcode\": \"95110\",\r\n\t\t\"country\": \"\",\r\n\t\t\"phone\": \"\",\r\n\t\t\"workphone\": \"\",\r\n\t\t\"fax\": \"\",\r\n\t\t\"otherphone\": \"\",\r\n\t\t\"email\": \"\",\r\n\t\t\"cell\": \"\",\r\n\t\t\"practice_id\": \"2\",\r\n\t\t\"practice\": {\r\n\t\t\t\"href\": \"https://qaapi.sikkasoft.com/v2/practices/2\"\r\n\t\t},\r\n\t\t\"relationship\": \"(Unknown)\"\r\n\t}]\r\n}]"}],"_postman_id":"ed05edec-76c3-435a-b29a-d200fdacdb38"}],"id":"2fdd63d6-b36d-4c48-9a6d-ae00365f5c03","description":"

It contains all APIs related with patient information , like patient name , address , perio charts , documents , medical history,prescriptions ,x-rays , reminders etc. Exlore the document for more details

\n","_postman_id":"2fdd63d6-b36d-4c48-9a6d-ae00365f5c03"},{"name":"Procedure codes","item":[{"name":"procedure_codes","id":"d1526c80-717b-4600-8d53-8126abf49067","request":{"method":"GET","header":[],"url":"{{url}}/procedure_codes?request_key={{request_key}}","description":"

Get the collection of all procedure codes using by practice management systems.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
procedure_code_category	As per the procedure code category in API response.	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
procedure_code	Procedure code as per practice management system

","urlObject":{"path":["procedure_codes"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"6ee7fc38-a143-4fe9-add5-894849a5e93b","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/procedure_codes?request_key={{request_key}}","host":["{{url}}"],"path":["procedure_codes"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1196","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:15:17 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"765\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_codes\\/ZTRAY\",\"procedure_code\":\"ZTRAY\",\"procedure_code_description\":\"WHITENING-TAKE HOME TRAYS\",\"abbreaviation\":\"ZTRAY\",\"procedure_code_category\":\"\",\"practice_id\":\"1\",\"procedure_code_category_id\":\"\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"explosion_code\":\"\",\"submit_to_insurance\":\"\",\"allow_discount\":\"\",\"procedure_code_effect_on_patient_balance\":\"\",\"procedure_code_effect_on_provider_production\":\"\",\"procedure_code_effect_on_provider_collection\":\"\",\"procedure_code_type\":\"\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_codes\\/ZOOM\",\"procedure_code\":\"ZOOM\",\"procedure_code_description\":\"WHITENING-ZOOM IN OFFICE\",\"abbreaviation\":\"ZOOM\",\"procedure_code_category\":\"\",\"practice_id\":\"1\",\"procedure_code_category_id\":\"\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"explosion_code\":\"\",\"submit_to_insurance\":\"\",\"allow_discount\":\"\",\"procedure_code_effect_on_patient_balance\":\"\",\"procedure_code_effect_on_provider_production\":\"\",\"procedure_code_effect_on_provider_collection\":\"\",\"procedure_code_type\":\"\"}]}]\r\n"}],"_postman_id":"d1526c80-717b-4600-8d53-8126abf49067"},{"name":"procedure_codes by procedure_code","id":"0110cbf9-ebcf-49e4-9814-a94c248516d8","request":{"method":"GET","header":[],"url":"{{url}}/procedure_codes/{procedure_code}?request_key={{request_key}}","description":"

Get the procedure code , description , category, abbreviation based on procedure code

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
procedure_code_category	As per the procedure code category in API response.	No

Sortby

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
procedure_code	Procedure code as per practice management system

","urlObject":{"path":["procedure_codes","{procedure_code}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"ef115ba7-1055-4a08-adc5-57e5a2422b4e","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/procedure_codes/{procedure_code}?request_key={{request_key}}","host":["{{url}}"],"path":["procedure_codes","{procedure_code}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"571","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:18:25 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_codes\\/ZTRAY\",\"procedure_code\":\"ZTRAY\",\"procedure_code_description\":\"WHITENING-TAKE HOME TRAYS\",\"abbreaviation\":\"ZTRAY\",\"procedure_code_category\":\"\",\"practice_id\":\"1\",\"procedure_code_category_id\":\"\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"explosion_code\":\"\",\"submit_to_insurance\":\"\",\"allow_discount\":\"\",\"procedure_code_effect_on_patient_balance\":\"\",\"procedure_code_effect_on_provider_production\":\"\",\"procedure_code_effect_on_provider_collection\":\"\",\"procedure_code_type\":\"\"}\r\n"}],"_postman_id":"0110cbf9-ebcf-49e4-9814-a94c248516d8"},{"name":"procedure_categories","id":"2fabfd61-d34f-4bce-aef9-0d68cc8e414d","request":{"method":"GET","header":[],"url":"{{url}}/procedure_categories?request_key={{request_key}}","description":"

Display all the procedure categories. Note: These procedure categories are mapped categories from practice management system. To get the list of practice management system procedure category name use \"procedure_category_mapping\" API.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
category	procedure category name

","urlObject":{"path":["procedure_categories"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"d8735a10-ed9e-4b20-ab6f-7434b51f5527","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/procedure_categories?request_key={{request_key}}","host":["{{url}}"],"path":["procedure_categories"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"468","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:30:47 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"212\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_categories\\/ViziLite\",\"category\":\"ViziLite\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_categories\\/Vestibuloplasty\",\"category\":\"Vestibuloplasty\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"2fabfd61-d34f-4bce-aef9-0d68cc8e414d"},{"name":"procedure_categories by category","id":"a3e3f934-ce57-424b-a79b-488963a9cfb6","request":{"method":"GET","header":[],"url":"{{url}}/procedure_categories/{category}?request_key={{request_key}}","description":"

Display only procedure category information as per request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
category	procedure category name

","urlObject":{"path":["procedure_categories","{category}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"78c6899a-f779-47c4-8b7d-2cb028f5a1f8","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/procedure_categories/{category}?request_key={{request_key}}","host":["{{url}}"],"path":["procedure_categories","{category}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"198","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:32:38 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_categories\\/ViziLite\",\"category\":\"ViziLite\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"a3e3f934-ce57-424b-a79b-488963a9cfb6"},{"name":"procedure_category_mapping","id":"415887a5-95ad-48dd-b7e6-b0754cb0659e","request":{"method":"GET","header":[],"url":"{{url}}/procedure_category_mapping?request_key={{request_key}}","description":"

Display mapped procedure category , procedure category as per practice management system , procedure description as per practice management system & procedure code.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
procedure_code	Procedure code as per practice management system	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
category	procedure category name for getting the list of codes mapped into veterinary dictionary
practice_id	Practice ID
procedure_code	Procedure code as per practice management system

","urlObject":{"path":["procedure_category_mapping"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"0d213782-b31c-48ca-886c-d85b27b275d2","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/procedure_category_mapping?request_key={{request_key}}","host":["{{url}}"],"path":["procedure_category_mapping"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"900","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:34:58 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"1559\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_category_mapping\\/ViziLite\",\"category\":\"ViziLite\",\"pms_procedure_category\":\"\",\"pms_procedure_description\":\"VELSCOPE- CANCER & PRECANCER SCREEN\",\"procedure_code\":\"D0431\",\"procedure_codes\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_codes\\/D0431\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_category_mapping\\/Veneer\",\"category\":\"Veneer\",\"pms_procedure_category\":\"\",\"pms_procedure_description\":\"VENEER-LABIAL PORCELAIN LAMINATE LAB\",\"procedure_code\":\"02962\",\"procedure_codes\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_codes\\/02962\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"415887a5-95ad-48dd-b7e6-b0754cb0659e"},{"name":"procedure_category_mapping by category","id":"40330462-297f-4a4b-894c-5562c3c2f6e2","request":{"method":"GET","header":[],"url":"{{url}}/procedure_category_mapping/{category}?request_key={{request_key}}","description":"

Display only procedure category mapping information as per the request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
procedure_code	Procedure code as per practice management system	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
category	procedure category name for getting the list of codes mapped into veterinary dictionary
practice_id	Practice ID
procedure_code	Procedure code as per practice management system

","urlObject":{"path":["procedure_category_mapping","{category}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"a1490e81-3fe9-4b6c-9bcf-1d556a8b7d6c","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/procedure_category_mapping/{category}?request_key={{request_key}}","host":["{{url}}"],"path":["procedure_category_mapping","{category}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"422","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:11:24 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_category_mapping\\/ViziLite\",\"category\":\"ViziLite\",\"pms_procedure_category\":\"\",\"pms_procedure_description\":\"VELSCOPE- CANCER & PRECANCER SCREEN\",\"procedure_code\":\"D0431\",\"procedure_codes\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_codes\\/D0431\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"40330462-297f-4a4b-894c-5562c3c2f6e2"}],"id":"ba91e6db-0b64-4b53-b5a4-f3d357aefc13","description":"

It contains all APIs related with procedure codes in practice like procedure code list , category , mapping etc.

\n","_postman_id":"ba91e6db-0b64-4b53-b5a4-f3d357aefc13"},{"name":"Products","item":[{"name":"products","id":"e3260337-e467-4447-9ad6-417d231473bf","request":{"method":"GET","header":[],"url":"{{url}}/products?request_key={{request_key}}","description":"

It will return list of all available products in Practice Management Systems.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
product_id	ID of product based on practice management system

","urlObject":{"path":["products"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"9cf95bc2-a596-40bd-8bb6-a5f428a2e00e","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/products?request_key={{request_key}}","host":["{{url}}"],"path":["products"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"743","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:20:55 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"7189\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/products\\/9898\",\"product_id\":\"9898\",\"cost\":\"1.1740\",\"description\":\"KONG COZIE \\\"SPUNKY\\\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"product_detail\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/veterinary_product_details\\/9898\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/products\\/9898\",\"product_id\":\"9898\",\"cost\":\"5.8700\",\"description\":\"KONG COZIE \\\"SPUNKY\\\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"product_detail\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/veterinary_product_details\\/9898\"}}]}]\r\n"}],"_postman_id":"e3260337-e467-4447-9ad6-417d231473bf"},{"name":"products by product_id","id":"d3c816c2-c8e2-4285-81da-054695ef6472","request":{"method":"GET","header":[],"url":"{{url}}/products/{product_id}?request_key={{request_key}}","description":"

Get the information about product based on product id.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
product_id	ID of product based on practice management system

","urlObject":{"path":["products","{product_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"ddcce0d0-cb03-47b0-aa9e-ee3ff7bbd894","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/products/{product_id}?request_key={{request_key}}","host":["{{url}}"],"path":["products","{product_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"342","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:22:36 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/products\\/9898\",\"product_id\":\"9898\",\"cost\":\"1.1740\",\"description\":\"KONG COZIE \\\"SPUNKY\\\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"product_detail\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/veterinary_product_details\\/9898\"}}\r\n"}],"_postman_id":"d3c816c2-c8e2-4285-81da-054695ef6472"},{"name":"hearing_aid_products","id":"b20ca963-a7e2-4a27-a083-ff30c0a36c27","request":{"method":"GET","header":[],"url":"{{url}}/hearing_aid_products?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
manufacturer_id	Manufacturer Id
model_id	Model Id

","urlObject":{"path":["hearing_aid_products"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"7eb9ce89-659f-4cca-a029-f3a77869b81d","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/hearing_aid_products?request_key={{request_key}}","host":["{{url}}"],"path":["hearing_aid_products"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"997","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:03:43 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"588\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-631\\/hearing_aid_products\\/Xino Tinnitus\",\"model_id\":\"Xino Tinnitus\",\"battery\":\"\",\"qb_id\":\"\",\"manufacturer_id\":\"Starkey\",\"model\":\"Xino Tinnitus\",\"price\":\"3245.0000\",\"tax\":\"0%\",\"technology\":\"Digital\",\"type\":\"RIC\",\"practice_id\":\"1-631\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-631\"},\"manufacturer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-631\\/manufacturers\\/Starkey\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-632\\/hearing_aid_products\\/Xino Classic 20\",\"model_id\":\"Xino Classic 20\",\"battery\":\"312\",\"qb_id\":\"\",\"manufacturer_id\":\"Starkey\",\"model\":\"Xino Classic 20\",\"price\":\"1745.0000\",\"tax\":\"8.625%\",\"technology\":\"Digital\",\"type\":\"RIC\",\"practice_id\":\"1-632\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-632\"},\"manufacturer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-632\\/manufacturers\\/Starkey\"}}]}]\r\n"}],"_postman_id":"b20ca963-a7e2-4a27-a083-ff30c0a36c27"},{"name":"hearing_aid_products by model_id","id":"e688c61e-724f-423c-946e-bd369d31e2ca","request":{"method":"GET","header":[],"url":"{{url}}/hearing_aid_products/{model_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
manufacturer_id	Manufacturer Id
model_id	Model Id

","urlObject":{"path":["hearing_aid_products","{model_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"c813f0b5-b8e7-41d5-b5f4-c39d1f6f3949","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/hearing_aid_products/{model_id}?request_key={{request_key}}","host":["{{url}}"],"path":["hearing_aid_products","{model_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"463","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:06:04 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-631\\/hearing_aid_products\\/Xino Tinnitus\",\"model_id\":\"Xino Tinnitus\",\"battery\":\"\",\"qb_id\":\"\",\"manufacturer_id\":\"Starkey\",\"model\":\"Xino Tinnitus\",\"price\":\"3245.0000\",\"tax\":\"0%\",\"technology\":\"Digital\",\"type\":\"RIC\",\"practice_id\":\"1-631\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-631\"},\"manufacturer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-631\\/manufacturers\\/Starkey\"}}\r\n"}],"_postman_id":"e688c61e-724f-423c-946e-bd369d31e2ca"},{"name":"hearing_care_product_details","id":"10890b8c-147a-48da-802e-23377988adde","request":{"method":"GET","header":[],"url":"{{url}}/hearing_care_product_details?request_key={{request_key}}","description":"

Get the list of all hearing care product details with additional information of product API.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
product_id	ID of product based on practice management system

","urlObject":{"path":["hearing_care_product_details"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"27013897-4762-4d19-8e15-33db68d28583","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/hearing_care_product_details?request_key={{request_key}}&limit=2","host":["{{url}}"],"path":["hearing_care_product_details"],"query":[{"key":"request_key","value":"{{request_key}}"},{"key":"limit","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"957","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 12:24:04 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"588\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-631\\/hearing_care_product_details\\/Xino Tinnitus\",\"product_id\":\"Xino Tinnitus\",\"practice_id\":\"1-631\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-631\"},\"price\":\"3245.0000\",\"battery\":\"\",\"quickbooks_id\":\"\",\"manufacturer_id\":\"Starkey\",\"manufacturer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-631\\/manufacturers\\/Starkey\"},\"tax\":\"0%\",\"technology\":\"Digital\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-632\\/hearing_care_product_details\\/Xino Classic 20\",\"product_id\":\"Xino Classic 20\",\"practice_id\":\"1-632\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-632\"},\"price\":\"1745.0000\",\"battery\":\"312\",\"quickbooks_id\":\"\",\"manufacturer_id\":\"Starkey\",\"manufacturer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-632\\/manufacturers\\/Starkey\"},\"tax\":\"8.625%\",\"technology\":\"Digital\"}]}]\r\n"}],"_postman_id":"10890b8c-147a-48da-802e-23377988adde"},{"name":"hearing_care_product_details by product_id","id":"3287a6d3-e0cc-4e5f-b10d-a1f8f9522c90","request":{"method":"GET","header":[],"url":"{{url}}/hearing_care_product_details/{product_id}?request_key={{request_key}}","description":"

Get the hearing care product detail information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID

","urlObject":{"path":["hearing_care_product_details","{product_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"5fd4e171-f270-4025-905b-03e25fb970ba","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/hearing_care_product_details/{product_id}?request_key={{request_key}}","host":["{{url}}"],"path":["hearing_care_product_details","{product_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"444","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:10:11 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-631\\/hearing_care_product_details\\/Xino Tinnitus\",\"product_id\":\"Xino Tinnitus\",\"practice_id\":\"1-631\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-631\"},\"price\":\"3245.0000\",\"battery\":\"\",\"quickbooks_id\":\"\",\"manufacturer_id\":\"Starkey\",\"manufacturer\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1-631\\/manufacturers\\/Starkey\"},\"tax\":\"0%\",\"technology\":\"Digital\"}\r\n"}],"_postman_id":"3287a6d3-e0cc-4e5f-b10d-a1f8f9522c90"},{"name":"manufacturers","id":"2cf84a07-eb5c-4d6c-87b4-f6d774b274ea","request":{"method":"GET","header":[],"url":"{{url}}/manufacturers?request_key={{request_key}}","description":"

Get the detail information and collection of manufacture's list.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
manufacturer_id	Manufacturer Id

","urlObject":{"path":["manufacturers"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"c97df45f-d0c5-4a55-90d8-7cf33c582d06","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/manufacturers?request_key={{request_key}}","host":["{{url}}"],"path":["manufacturers"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"800","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:51:10 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"215\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/manufacturers\\/100005\",\"manufacturer_id\":\"100005\",\"status\":\"\",\"updated_date\":\"2006-07-04\",\"name\":\"Flexon\\/Fendi\",\"contact\":\"\",\"notes\":\"\",\"address_line1\":\"\",\"address_line2\":\"\",\"city\":\"\",\"state\":\"\",\"zip_code\":\"\",\"phone\":\"\",\"fax\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/manufacturers\\/100004\",\"manufacturer_id\":\"100004\",\"status\":\"\",\"updated_date\":\"2004-10-14\",\"name\":\"Nautica\",\"contact\":\"\",\"notes\":\"\",\"address_line1\":\"\",\"address_line2\":\"\",\"city\":\"\",\"state\":\"\",\"zip_code\":\"\",\"phone\":\"\",\"fax\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"2cf84a07-eb5c-4d6c-87b4-f6d774b274ea"},{"name":"manufacturers by manufacturer_id","id":"5bc89572-7cca-472c-90ef-6540c5a312cc","request":{"method":"GET","header":[],"url":"{{url}}/manufacturers/{manufacturer_id}?request_key={{request_key}}","description":"

Get the manufacturer's contact details , status as per manufacturer id.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
manufacturer_id	Manufacturer Id

","urlObject":{"path":["manufacturers","{manufacturer_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"73adeca5-7b1c-462a-ad9e-c0391ba568c3","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/manufacturers/{manufacturer_id}?request_key={{request_key}}","host":["{{url}}"],"path":["manufacturers","{manufacturer_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"374","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 24 Apr 2017 11:53:25 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/manufacturers\\/100005\",\"manufacturer_id\":\"100005\",\"status\":\"\",\"updated_date\":\"2006-07-04\",\"name\":\"Flexon\\/Fendi\",\"contact\":\"\",\"notes\":\"\",\"address_line1\":\"\",\"address_line2\":\"\",\"city\":\"\",\"state\":\"\",\"zip_code\":\"\",\"phone\":\"\",\"fax\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"5bc89572-7cca-472c-90ef-6540c5a312cc"},{"name":"optometry_product_details","id":"d1a275e3-113c-428f-b991-98899e517368","request":{"method":"GET","header":[],"url":"{{url}}/optometry_product_details?request_key={{request_key}}","description":"

Get the list of all optometry products details with additional information of product API.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
product_id	ID of product based on practice management system

","urlObject":{"path":["optometry_product_details"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"7e4ef2a2-95ff-4948-8aef-cc85285b4cd8","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/optometry_product_details?request_key={{request_key}}","host":["{{url}}"],"path":["optometry_product_details"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1317","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:17:35 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"1148\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/optometry_product_details\\/97\",\"product_id\":\"97\",\"cost\":\"0.0000\",\"description\":\"Rigid Contact Lenses\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"type\":\"Contact Lenses\",\"stock_type\":\"\",\"lens_category\":\"\",\"vendor_name\":\"\",\"style\":\"WESTCON BITORIC\",\"material\":\"\",\"fee\":\"0.0000\",\"fee_change_date\":\"\",\"mesure_unit\":\"Each\",\"cost_change_date\":\"\",\"average_cost\":\"0.0000\",\"tax_type\":\"\",\"lens_per_pack\":\"0\",\"designer_name\":\"\",\"mount\":\"\",\"gender\":\"\",\"frame_type\":\"\",\"frame_usage\":\"\",\"service_type\":\"Medical Care\",\"service_place\":\"Office\",\"group\":\"Rigid CL Fees\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/optometry_product_details\\/96\",\"product_id\":\"96\",\"cost\":\"0.0000\",\"description\":\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"type\":\"Contact Lenses\",\"stock_type\":\"\",\"lens_category\":\"\",\"vendor_name\":\"\",\"style\":\"WJ FRESHLOOK\",\"material\":\"\",\"fee\":\"0.0000\",\"fee_change_date\":\"\",\"mesure_unit\":\"Each\",\"cost_change_date\":\"\",\"average_cost\":\"0.0000\",\"tax_type\":\"\",\"lens_per_pack\":\"0\",\"designer_name\":\"\",\"mount\":\"\",\"gender\":\"\",\"frame_type\":\"\",\"frame_usage\":\"\",\"service_type\":\"\",\"service_place\":\"Office\",\"group\":\"\"}]}]\r\n"}],"_postman_id":"d1a275e3-113c-428f-b991-98899e517368"},{"name":"optometry_product_details by product_id","id":"63235507-f9a0-4238-8366-cfd13ce2e6bc","request":{"method":"GET","header":[],"url":"{{url}}/optometry_product_details/{product_id}?request_key={{request_key}}","description":"

Get the optometry product detail information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
product_id	ID of product based on practice management system

","urlObject":{"path":["optometry_product_details","{product_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"d8210f51-53b9-4168-9afa-bd37a33fe004","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/optometry_product_details/{product_id}?request_key={{request_key}}","host":["{{url}}"],"path":["optometry_product_details","{product_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"653","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:19:17 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/optometry_product_details\\/97\",\"product_id\":\"97\",\"cost\":\"0.0000\",\"description\":\"Rigid Contact Lenses\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"type\":\"Contact Lenses\",\"stock_type\":\"\",\"lens_category\":\"\",\"vendor_name\":\"\",\"style\":\"WESTCON BITORIC\",\"material\":\"\",\"fee\":\"0.0000\",\"fee_change_date\":\"\",\"mesure_unit\":\"Each\",\"cost_change_date\":\"\",\"average_cost\":\"0.0000\",\"tax_type\":\"\",\"lens_per_pack\":\"0\",\"designer_name\":\"\",\"mount\":\"\",\"gender\":\"\",\"frame_type\":\"\",\"frame_usage\":\"\",\"service_type\":\"Medical Care\",\"service_place\":\"Office\",\"group\":\"Rigid CL Fees\"}\r\n"}],"_postman_id":"63235507-f9a0-4238-8366-cfd13ce2e6bc"},{"name":"veterinary_product_details","id":"cfd7e2a3-8ced-4efd-bea6-dccadc7450c2","request":{"method":"GET","header":[],"url":"{{url}}/veterinary_product_details?request_key={{request_key}}","description":"

Get the list of all veterinary products details with additional information of product API.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
provider_id	Provider id as per practice management system	No
practice_id	Practice ID	No
vendor_id	Vendor id as per the practice management system	No
order_number	Order Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
vendor_id	Vendor id as per the practice management system
product_id	ID of product based on practice management system

","urlObject":{"path":["veterinary_product_details"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"1aeb071f-2fcf-481b-a8b5-11c9ed8ede38","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/veterinary_product_details?request_key={{request_key}}","host":["{{url}}"],"path":["veterinary_product_details"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1929","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 09:25:57 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"7189\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/veterinary_product_details\\/9898\",\"product_id\":\"9898\",\"cost\":\"1.1740\",\"category\":\"Dog toys & chews\",\"description\":\"KONG COZIE \\\"SPUNKY\\\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"package_cost\":\"5.8700\",\"price\":\"6.6263\",\"location\":\"\",\"provider_id\":\"\",\"expires_in\":\"\",\"mark_up_package_cost\":\"0.0000\",\"mark_up_unit_cost\":\"0.0000\",\"expired_date\":\"2016-01-08\",\"mark_up_percent\":\"\",\"months\":\"\",\"container\":\"\",\"on_order\":\"\",\"order_quantity\":\"5.0000\",\"order_pack\":\"5.0000\",\"alloted_quantity\":\"\",\"manufacturing_number\":\"6494320\",\"average_unit_cost\":\"0.0000\",\"average_package_cost\":\"0.0000\",\"vendor_id\":\"1229258320\",\"vendor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/vendors\\/1229258320\"},\"on_hand_quantity\":\"2\",\"discount_class\":\"\",\"measure\":\"EACH\",\"order_number\":\"1412\",\"received_date\":\"2016-01-08\",\"vendor_item_id\":\"6494320\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/veterinary_product_details\\/9898\",\"product_id\":\"9898\",\"cost\":\"5.8700\",\"category\":\"Dog toys & chews\",\"description\":\"KONG COZIE \\\"SPUNKY\\\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"package_cost\":\"5.8700\",\"price\":\"6.6263\",\"location\":\"\",\"provider_id\":\"\",\"expires_in\":\"\",\"mark_up_package_cost\":\"0.0000\",\"mark_up_unit_cost\":\"0.0000\",\"expired_date\":\"2016-02-12\",\"mark_up_percent\":\"\",\"months\":\"\",\"container\":\"\",\"on_order\":\"\",\"order_quantity\":\"1.0000\",\"order_pack\":\"1.0000\",\"alloted_quantity\":\"\",\"manufacturing_number\":\"6494320\",\"average_unit_cost\":\"0.0000\",\"average_package_cost\":\"0.0000\",\"vendor_id\":\"1229258320\",\"vendor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/vendors\\/1229258320\"},\"on_hand_quantity\":\"2\",\"discount_class\":\"\",\"measure\":\"EACH\",\"order_number\":\"1435\",\"received_date\":\"2016-02-12\",\"vendor_item_id\":\"6494320\"}]}]\r\n"}],"_postman_id":"cfd7e2a3-8ced-4efd-bea6-dccadc7450c2"},{"name":"veterinary_product_details by product_id","id":"f477e416-ac7f-476a-aa4d-1f45de4dae74","request":{"method":"GET","header":[],"url":"{{url}}/veterinary_product_details/{product_id}?request_key={{request_key}}","description":"

Get the veterinary product detail information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
provider_id	Provider id as per practice management system	No
practice_id	Practice ID	No
vendor_id	Vendor id as per the practice management system	No
order_number	Order Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
vendor_id	Vendor id as per the practice management system
product_id	ID of product based on practice management system

","urlObject":{"path":["veterinary_product_details","{product_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"d0959b7d-8462-4240-96eb-96cc1b5276b3","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/veterinary_product_details/{product_id}?request_key={{request_key}}","host":["{{url}}"],"path":["veterinary_product_details","{product_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"935","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 09:28:55 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/veterinary_product_details\\/9898\",\"product_id\":\"9898\",\"cost\":\"1.1740\",\"category\":\"Dog toys & chews\",\"description\":\"KONG COZIE \\\"SPUNKY\\\"\",\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"package_cost\":\"5.8700\",\"price\":\"6.6263\",\"location\":\"\",\"provider_id\":\"\",\"expires_in\":\"\",\"mark_up_package_cost\":\"0.0000\",\"mark_up_unit_cost\":\"0.0000\",\"expired_date\":\"2016-01-08\",\"mark_up_percent\":\"\",\"months\":\"\",\"container\":\"\",\"on_order\":\"\",\"order_quantity\":\"5.0000\",\"order_pack\":\"5.0000\",\"alloted_quantity\":\"\",\"manufacturing_number\":\"6494320\",\"average_unit_cost\":\"0.0000\",\"average_package_cost\":\"0.0000\",\"vendor_id\":\"1229258320\",\"vendor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/vendors\\/1229258320\"},\"on_hand_quantity\":\"2\",\"discount_class\":\"\",\"measure\":\"EACH\",\"order_number\":\"1412\",\"received_date\":\"2016-01-08\",\"vendor_item_id\":\"6494320\"}\r\n"}],"_postman_id":"f477e416-ac7f-476a-aa4d-1f45de4dae74"},{"name":"veterinary_product_inventory","id":"475ae13c-080f-4031-8a6f-5117952921e5","request":{"method":"GET","header":[],"url":"{{url}}/veterinary_product_inventory?request_key={{request_key}}","description":"

Display inventory details with product id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
product_id	ID of product based on practice management system

","urlObject":{"path":["veterinary_product_inventory"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"3e1e8a7c-f4dd-4fea-a3ec-1a97bb916287","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/veterinary_product_inventory?request_key={{request_key}}","host":["{{url}}"],"path":["veterinary_product_inventory"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1050","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 09:31:10 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"1385\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/veterinary_product_inventory\\/9999\",\"product_id\":\"9999\",\"description\":\"AZITHROMYCIN 100MG\\/5ML SUSPENSION\",\"category\":\"Hospital Use\",\"price\":\"12.5500\",\"on_hand_quantity\":\"-7\",\"measure\":\"EACH\",\"vendor_item_id\":\"5061120\",\"manufacturing_number\":\"5061120\",\"vendor_id\":\"1229258320\",\"vendor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/vendors\\/1229258320\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/veterinary_product_inventory\\/9898\",\"product_id\":\"9898\",\"description\":\"KONG COZIE \\\"SPUNKY\\\"\",\"category\":\"Dog toys & chews\",\"price\":\"6.6263\",\"on_hand_quantity\":\"2\",\"measure\":\"EACH\",\"vendor_item_id\":\"\",\"manufacturing_number\":\"\",\"vendor_id\":\"1056229654\",\"vendor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/vendors\\/1056229654\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}]}]\r\n"}],"_postman_id":"475ae13c-080f-4031-8a6f-5117952921e5"},{"name":"veterinary_product_inventory by product_id","id":"b39479ec-57e8-4472-bf33-2215e2edb27c","request":{"method":"GET","header":[],"url":"{{url}}/veterinary_product_inventory/{product_id}?request_key={{request_key}}","description":"

Display inventory details with product id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
product_id	ID of product based on practice management system

","urlObject":{"path":["veterinary_product_inventory","{product_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"0f2b43f8-c658-4cf8-8098-ddbe4d140fa5","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/veterinary_product_inventory/{product_id}?request_key={{request_key}}","host":["{{url}}"],"path":["veterinary_product_inventory","{product_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"508","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 09:34:52 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/veterinary_product_inventory\\/9999\",\"product_id\":\"9999\",\"description\":\"AZITHROMYCIN 100MG\\/5ML SUSPENSION\",\"category\":\"Hospital Use\",\"price\":\"12.5500\",\"on_hand_quantity\":\"-7\",\"measure\":\"EACH\",\"vendor_item_id\":\"5061120\",\"manufacturing_number\":\"5061120\",\"vendor_id\":\"1229258320\",\"vendor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/vendors\\/1229258320\"},\"practice_id\":\"1\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"b39479ec-57e8-4472-bf33-2215e2edb27c"},{"name":"vendors","id":"35b368d2-212c-43e9-b796-1488601e1d3d","request":{"method":"GET","header":[],"url":"{{url}}/vendors?request_key={{request_key}}","description":"

Get the list of all vendors available in Practice management systems

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
vendor_id	Vendor id as per the practice management system	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
vendor_id	Vendor id as per the practice management system
vendor_code	Vendor Code

","urlObject":{"path":["vendors"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"a46bf638-0c12-454d-8412-ccdcf481eb80","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/vendors?request_key={{request_key}}","host":["{{url}}"],"path":["vendors"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"978","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 09:11:00 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"11\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/vendors/282093690\",\n \"vendor_id\": \"282093690\",\n \"vendor_code\": \"282093690\",\n \"account\": \"\",\n \"address\": \"\",\n \"city\": \"(None)\",\n \"contact\": \"\",\n \"email\": \"\",\n \"fax\": \"\",\n \"name\": \"Hill's Pet Nutrition Canada Inc.\",\n \"other\": \"\",\n \"phone\": \"( ) - ext:\",\n \"practice_id\": \"1\",\n \"state\": \"\",\n \"terms\": \"\",\n \"vendor_status\": \"\",\n \"vendor_type\": \"\",\n \"website\": \"\",\n \"zip\": \"\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/vendors/240970935\",\n \"vendor_id\": \"240970935\",\n \"vendor_code\": \"240970935\",\n \"account\": \"\",\n \"address\": \"1000 UPJOHN CIRCLE KALAMAZOO MI\",\n \"city\": \"(None)\",\n \"contact\": \"\",\n \"email\": \"\",\n \"fax\": \"\",\n \"name\": \"THE UPJOHN COMPANY\",\n \"other\": \"\",\n \"phone\": \"(123) 234-3456 ext:\",\n \"practice_id\": \"1\",\n \"state\": \"\",\n \"terms\": \"\",\n \"vendor_status\": \"\",\n \"vendor_type\": \"\",\n \"website\": \"\",\n \"zip\": \"\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n }\n }\n ]\n }\n]"}],"_postman_id":"35b368d2-212c-43e9-b796-1488601e1d3d"},{"name":"vendors by vendor_id","id":"2415fa5f-8a99-424c-967a-d511cfe21f90","request":{"method":"GET","header":[],"url":"{{url}}/vendors/{vendor_id}?request_key={{request_key}}","description":"

Get the information about vendor based on vendor id.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
vendor_id	Vendor id as per the practice management system	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
treatment_plan_sr_no	Treatment plan serial number from Practice management System
amount	Amount
procedure_date	Procedure Date
entry_date	Entry Date

","urlObject":{"path":["vendors","{vendor_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"60ecd00b-2d3e-4ae5-94b5-fc8ec9500687","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/vendors/{vendor_id}?request_key={{request_key}}","host":["{{url}}"],"path":["vendors","{vendor_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"452","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 09:13:35 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/vendors\\/282093690\",\"vendor_id\":\"282093690\",\"vendor_code\":\"282093690\",\"account\":\"\",\"address\":\"\",\"city\":\"(None)\",\"contact\":\"\",\"email\":\"\",\"fax\":\"\",\"name\":\"Hill's Pet Nutrition Canada Inc.\",\"other\":\"\",\"phone\":\"( ) - ext:\",\"practice_id\":\"1\",\"state\":\"\",\"terms\":\"\",\"vendor_status\":\"\",\"vendor_type\":\"\",\"website\":\"\",\"zip\":\"\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"}}\r\n"}],"_postman_id":"2415fa5f-8a99-424c-967a-d511cfe21f90"},{"name":"purchase_orders","id":"055d5ad2-7f17-4500-8493-64f79be58075","request":{"method":"GET","header":[],"url":"{{url}}/purchase_orders?request_key={{request_key}}","description":"

Display the list of all purchase orders from practice management system.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
vendor_id	Vendor id as per the practice management system	No
procedure_code_id	Procedure code id is same as procedure code.	No
order_number	Order Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
vendor_id	Vendor id as per the practice management system
procedure_code_id	Procedure code id is same as procedure code.

","urlObject":{"path":["purchase_orders"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"da1256d3-215d-4d52-a244-53be1af3ae4d","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/purchase_orders?request_key={{request_key}}","host":["{{url}}"],"path":["purchase_orders"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1516","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:29:43 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"2\",\"total_count\":\"7820\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/purchase_orders\\/1678490447\",\"vendor_id\":\"1678490447\",\"order_date\":\"2014-09-23\",\"cost\":\"13\",\"freight\":\"0.0000\",\"invoice_amount\":\"0\",\"invoice_date\":\"\",\"invoice_number\":\"\",\"item_description\":\"METRONIDAZOLE 50MG TABLETS\",\"location\":\"\",\"order_number\":\"1079\",\"practice_id\":\"1\",\"procedure_code\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_codes\\/2223\"},\"procedure_code_id\":\"2223\",\"quantity\":\"0.0000\",\"receipt_date\":\"2014-09-23\",\"receipt_number\":\"\",\"status\":\"Closed\",\"tax\":\"1.6891\",\"unit_cost\":\"0.26\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"vendor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/vendors\\/1678490447\"}},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/purchase_orders\\/1678490447\",\"vendor_id\":\"1678490447\",\"order_date\":\"2014-12-09\",\"cost\":\"65\",\"freight\":\"0.0000\",\"invoice_amount\":\"0\",\"invoice_date\":\"\",\"invoice_number\":\"\",\"item_description\":\"TRAMADOL HCL 50MG TABLETS\",\"location\":\"\",\"order_number\":\"1147\",\"practice_id\":\"1\",\"procedure_code\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_codes\\/3523\"},\"procedure_code_id\":\"3523\",\"quantity\":\"0.0000\",\"receipt_date\":\"2014-12-09\",\"receipt_number\":\"\",\"status\":\"Closed\",\"tax\":\"8.4502\",\"unit_cost\":\"0.52\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"vendor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/vendors\\/1678490447\"}}]}]\r\n"}],"_postman_id":"055d5ad2-7f17-4500-8493-64f79be58075"},{"name":"purchase_orders by vendor_id","id":"5d6b7d0b-5210-4f92-9375-ff5727f476a6","request":{"method":"GET","header":[],"url":"{{url}}/purchase_orders/{vendor_id}?request_key={{request_key}}","description":"

Get the purchase order based on vendor id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
vendor_id	Vendor id as per the practice management system	No
procedure_code_id	Procedure code id is same as procedure code.	No
order_number	Order Number	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
practice_id	Practice ID
vendor_id	Vendor id as per the practice management system
procedure_code_id	Procedure code id is same as procedure code.

","urlObject":{"path":["purchase_orders","{vendor_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"bf911a81-c50a-4a50-b82b-eb4ccf7ec2bc","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/purchase_orders/{vendor_id}?request_key={{request_key}}","host":["{{url}}"],"path":["purchase_orders","{vendor_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"729","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 08:32:29 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/purchase_orders\\/1678490447\",\"vendor_id\":\"1678490447\",\"order_date\":\"2014-09-23\",\"cost\":\"13\",\"freight\":\"0.0000\",\"invoice_amount\":\"0\",\"invoice_date\":\"\",\"invoice_number\":\"\",\"item_description\":\"METRONIDAZOLE 50MG TABLETS\",\"location\":\"\",\"order_number\":\"1079\",\"practice_id\":\"1\",\"procedure_code\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/procedure_codes\\/2223\"},\"procedure_code_id\":\"2223\",\"quantity\":\"0.0000\",\"receipt_date\":\"2014-09-23\",\"receipt_number\":\"\",\"status\":\"Closed\",\"tax\":\"1.6891\",\"unit_cost\":\"0.26\",\"practice\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\"},\"vendor\":{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/practices\\/1\\/vendors\\/1678490447\"}}\r\n"}],"_postman_id":"5d6b7d0b-5210-4f92-9375-ff5727f476a6"}],"id":"93c2643b-96dd-4fd3-8a08-a92698211bc1","description":"

It contains all APIs related with products in practice, like hearing aid , optometry products , veterinary products , manufacturers etc..

\n","_postman_id":"93c2643b-96dd-4fd3-8a08-a92698211bc1"},{"name":"Practice Mobilizer","item":[{"name":"fee_schedule_optimizer","id":"37420399-87c9-4da9-a3d7-b2a2388c5d90","request":{"method":"GET","header":[],"url":"{{url}}/fee_schedule_optimizer?request_key={{request_key}}&practice_id={practice_id}&startdate={startdate}&enddate={enddate}","description":"

This API to optimize fees for your practice.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	Yes
startdate	format: yyyy-mm-dd, start date	Yes
enddate	format: yyyy-mm-dd, end date	Yes
zipcode	Zipcode	No
fee_name	Name of fee schedule	No

","urlObject":{"path":["fee_schedule_optimizer"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"},{"key":"practice_id","value":"{practice_id}"},{"key":"startdate","value":"{startdate}"},{"key":"enddate","value":"{enddate}"}],"variable":[]}},"response":[{"id":"18119fd1-7588-4d23-8e8f-df8c1b009bdd","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/fee_schedule_optimizer?request_key={{request_key}}&practice_id={practice_id}&startdate={startdate}&enddate={enddate}","host":["{{url}}"],"path":["fee_schedule_optimizer"],"query":[{"key":"request_key","value":"{{request_key}}"},{"key":"practice_id","value":"{practice_id}"},{"key":"startdate","value":"{startdate}"},{"key":"enddate","value":"{enddate}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[{\r\n\t\"offset\": \"0\",\r\n\t\"limit\": \"500\",\r\n\t\"total_count\": \"1\",\r\n\t\"fee_schedule_optimizer_production \": [{\r\n\t\t\"adjusted_production\": \"9962.22\",\r\n\t\t\"new_adjusted_production\": \"11301.24180084\",\r\n\t\t\"difference_in_production\": \"1352.02180084\",\r\n\t\t\"fee_name\": \"23\",\r\n\t\t\"startdate\": \"2016-01-01\",\r\n\t\t\"enddate\": \"2016-09-01\"\r\n\t}],\r\n\t\"fee_schedule_optimizer_fees\": [{\r\n\t\t\"Procedure_code\": \"2740\",\r\n\t\t\"description\": \"Crown/Ceramic Substrate\",\r\n\t\t\"count\": \"165\",\r\n\t\t\"current_fee\": \"1078\",\r\n\t\t\"new_fee\": \"131.40973535156\",\r\n\t\t\"current_production\": \"1584.2\",\r\n\t\t\"new_production\": \"1987.093856\",\r\n\t\t\"increase_in_production\": \"362.898493856\",\r\n\t\t\"difference\": \"23.51%\",\r\n\t\t\"remarks\": \"Optimized\",\r\n\t\t\"seventy_percentile\": \"1402\",\r\n\t\t\"eighty_percentile\": \"1462\",\r\n\t\t\"ninty_percentile\": \"1596\"\r\n\t}]\r\n}]\r\n"}],"_postman_id":"37420399-87c9-4da9-a3d7-b2a2388c5d90"},{"name":"messages","id":"d9b89b90-082f-4053-a32e-bb7298cd5eb2","request":{"method":"GET","header":[],"url":"{{url}}/messages?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
provider_id	Provider id as per practice management system	No
practice_id	Practice ID	No
date	Filter on date field, format: yyyy-mm-dd	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
message_id	Message id as per in the response.

","urlObject":{"path":["messages"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"7ff09d2b-391c-4dc1-87b3-87a661a46475","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/messages?request_key={{request_key}}","host":["{{url}}"],"path":["messages"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"4414","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:00:47 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"9187\",\n \"items\": [\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/messages/9311\",\n \"message_id\": \"9311\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"patient_id\": \"4032\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/4032\"\n },\n \"from\": \"Maureen Murphy-Eaton\",\n \"to\": \"Bruce Mathes\",\n \"date\": \"2014-06-28 17:53:00\",\n \"subject\": \"Maureen Murphy-Eaton has sent you feedback from PatientHomePage\",\n \"body\": \"

Hello,

Maureen Murphy-Eaton has sent you feedback from PatientHomePage.

Date : June 28, 2014

Q1. How would you rate your overall visit?

Ans. Excellent

Q2. When your appointment was over did you have a good understanding of your situation?

Ans. Yes

Q3. Were your financial options explained to you?

Ans. Yes

Q4. Did you have to wait over 15 minutes past your appointment time to be seated? if so how long?

Ans. No

Q5. Did the staff greet you properly?

Ans. Yes

Q6. Would you refer your friends and family to our office?

Ans. Yes

Q7. Tell us about your experience with our office?

Ans. I am always treated with respect,and with a positive and friendly attitude from the entire staff. Dr. Mathes is always professional and answers questions thoroughly, with a friendly smile! Lynn is patient and kind,with a warm friendly personality. Thanks! Maureen

Thank You,

Maureen Murphy-Eaton

\",\n \"email\": \"murphygirl112@sbcglobal.net\",\n \"message_read\": \"NO\",\n \"user_type\": \"patient\",\n \"provider_setting\": \"\",\n \"patient_setting\": \"\",\n \"schedule_id\": \"\",\n \"campaign_name\": \"Sent feedback form\",\n \"appointment_date\": \"\",\n \"appointment_time\": \"\",\n \"sms_incoming_message\": \"\",\n \"provider_id\": \"\"\n },\n {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/messages/9310\",\n \"message_id\": \"9310\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"patient_id\": \"5739\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/5739\"\n },\n \"from\": \"Bruce Mathes\",\n \"to\": \"Nancy Murray\",\n \"date\": \"2014-06-28 00:00:00\",\n \"subject\": \"3096784800\",\n \"body\": \"Hi Nancy, Thank you for visiting us. Bruce Mathes D.D.S.. Type STOP to unsubscribe\",\n \"email\": \"feelinggrogsdg20@yahoo.com\",\n \"message_read\": \"NO\",\n \"user_type\": \"Dentist(SMS)\",\n \"provider_setting\": \"\",\n \"patient_setting\": \"\",\n \"schedule_id\": \"1263\",\n \"campaign_name\": \"Today's patients feedback form\",\n \"appointment_date\": \"\",\n \"appointment_time\": \"\",\n \"sms_incoming_message\": \"\",\n \"provider_id\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"d9b89b90-082f-4053-a32e-bb7298cd5eb2"},{"name":"messages by message_id","id":"9b762b94-a65c-4e13-a91e-9affa0ad2603","request":{"method":"GET","header":[],"url":"{{url}}/messages/{message_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
provider_id	Provider id as per practice management system	No
practice_id	Practice ID	No
date	Filter on date field, format: yyyy-mm-dd	No

SortBy

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
message_id	Message id as per in the response.

","urlObject":{"path":["messages","{message_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"6fd9fd19-20ba-43fd-8811-b234adaa14f2","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/messages/{message_id}?request_key={{request_key}}","host":["{{url}}"],"path":["messages","{message_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"753","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:06:01 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/messages/9310\",\n \"message_id\": \"9310\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"patient_id\": \"5739\",\n \"patient\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/5739\"\n },\n \"from\": \"Bruce Mathes\",\n \"to\": \"Nancy Murray\",\n \"date\": \"2014-06-28 00:00:00\",\n \"subject\": \"3096784800\",\n \"body\": \"Hi Nancy, Thank you for visiting us. Bruce Mathes D.D.S.. Type STOP to unsubscribe\",\n \"email\": \"feelinggrjgjg420@yahoo.com\",\n \"message_read\": \"NO\",\n \"user_type\": \"Dentist(SMS)\",\n \"provider_setting\": \"\",\n \"patient_setting\": \"\",\n \"schedule_id\": \"1263\",\n \"campaign_name\": \"Today's patients feedback form\",\n \"appointment_date\": \"\",\n \"appointment_time\": \"\",\n \"sms_incoming_message\": \"\",\n \"provider_id\": \"\"\n}"}],"_postman_id":"9b762b94-a65c-4e13-a91e-9affa0ad2603"},{"name":"messaging_invites","id":"c5522145-c9a1-4e8a-91c5-9b547d99b8de","request":{"method":"GET","header":[],"url":"{{url}}/messaging_invites?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
status	Status of patient	No

","urlObject":{"path":["messaging_invites"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"7297dc07-c929-4e45-8ddf-5be7b42f676b","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/messaging_invites?request_key={{request_key}}","host":["{{url}}"],"path":["messaging_invites"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1571","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:09:38 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"offset\": \"0\",\n \"limit\": \"2\",\n \"total_count\": \"1\",\n \"items\": [\n {\n \"request_key\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"provider_account_id\": \"\",\n \"provider_name\": \"\",\n \"patient_id\": \"10\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"phone\": \"+14083178790\",\n \"status\": \"Invited\",\n \"messaging_user_id\": \"000000000000000000000000\",\n \"channel_id\": \"000000000000000000000000\",\n \"firstname\": \"\",\n \"middlename\": \"\",\n \"lastname\": \"\",\n \"profile_pic_url\": \"\",\n \"birthdate\": \"\",\n \"guarantor_id\": \"\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"homephone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"email\": \"\",\n \"employer_id\": \"\",\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"provider_id\": \"\",\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments?patient_id=10\"\n },\n \"primary_insurance_company_id\": \"\",\n \"secondary_insurance_company_id\": \"\",\n \"primary_relationship\": \"\",\n \"country\": \"\",\n \"primary_medical_insurance\": \"\",\n \"primary_medical_insurance_id\": \"\",\n \"primary_medical_relationship\": \"\",\n \"primary_medical_subscriber_id\": \"\",\n \"secondary_medical_insurance\": \"\",\n \"secondary_medical_insurance_id\": \"\",\n \"secondary_medical_relationship\": \"\",\n \"secondary_medical_subscriber_id\": \"\",\n \"secondary_relationship\": \"\",\n \"subscriber_id\": \"\",\n \"patient_account_id\": \"\",\n \"other_referral\": \"\",\n \"patient_referral\": \"\",\n \"referred_out\": \"\",\n \"referred_by_provider_id\": \"\",\n \"referred_by_patient_id\": \"\",\n \"image\": \"\",\n \"thumb_image\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\"\n }\n ]\n}"}],"_postman_id":"c5522145-c9a1-4e8a-91c5-9b547d99b8de"},{"name":"messaging_invites by patient_id","id":"16de5974-f9c3-4fb9-89d2-747d43770f05","request":{"method":"GET","header":[],"url":"{{url}}/messaging_invites/{patient_id}?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
practice_id	Practice ID	No
status	Status of patient	No

","urlObject":{"path":["messaging_invites","{patient_id}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"24f72652-c619-457b-8127-93a0224b1151","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/messaging_invites/{patient_id}?request_key={{request_key}}","host":["{{url}}"],"path":["messaging_invites","{patient_id}"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"1573","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Wed, 26 Apr 2017 09:13:11 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"offset\": \"0\",\n \"limit\": \"500\",\n \"total_count\": \"1\",\n \"items\": [\n {\n \"request_key\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"provider_account_id\": \"\",\n \"provider_name\": \"\",\n \"patient_id\": \"10\",\n \"practice_id\": \"1\",\n \"practice\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1\"\n },\n \"phone\": \"+14083178790\",\n \"status\": \"Invited\",\n \"messaging_user_id\": \"000000000000000000000000\",\n \"channel_id\": \"000000000000000000000000\",\n \"firstname\": \"\",\n \"middlename\": \"\",\n \"lastname\": \"\",\n \"profile_pic_url\": \"\",\n \"birthdate\": \"\",\n \"guarantor_id\": \"\",\n \"preferred_name\": \"\",\n \"salutation\": \"\",\n \"patient_note\": \"\",\n \"medical_note\": \"\",\n \"alert_note\": \"\",\n \"other_note\": \"\",\n \"gender\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"homephone\": \"\",\n \"workphone\": \"\",\n \"cell\": \"\",\n \"email\": \"\",\n \"employer_id\": \"\",\n \"billing_type\": \"\",\n \"first_visit\": \"\",\n \"last_visit\": \"\",\n \"provider_id\": \"\",\n \"appointments\": {\n \"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments?patient_id=10\"\n },\n \"primary_insurance_company_id\": \"\",\n \"secondary_insurance_company_id\": \"\",\n \"primary_relationship\": \"\",\n \"country\": \"\",\n \"primary_medical_insurance\": \"\",\n \"primary_medical_insurance_id\": \"\",\n \"primary_medical_relationship\": \"\",\n \"primary_medical_subscriber_id\": \"\",\n \"secondary_medical_insurance\": \"\",\n \"secondary_medical_insurance_id\": \"\",\n \"secondary_medical_relationship\": \"\",\n \"secondary_medical_subscriber_id\": \"\",\n \"secondary_relationship\": \"\",\n \"subscriber_id\": \"\",\n \"patient_account_id\": \"\",\n \"other_referral\": \"\",\n \"patient_referral\": \"\",\n \"referred_out\": \"\",\n \"referred_by_provider_id\": \"\",\n \"referred_by_patient_id\": \"\",\n \"image\": \"\",\n \"thumb_image\": \"\",\n \"fee_no\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\"\n }\n ]\n}"}],"_postman_id":"16de5974-f9c3-4fb9-89d2-747d43770f05"},{"name":"practice_mobilizer_menus","id":"4faa91fc-0eb1-44fb-8048-48f319f97ea7","request":{"method":"GET","header":[],"url":"{{url}}/practice_mobilizer_menus?request_key={{request_key}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes

","urlObject":{"path":["practice_mobilizer_menus"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"8a53edc9-ee3a-48fb-80f8-7c7618d229ad","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/practice_mobilizer_menus?request_key={{request_key}}","host":["{{url}}"],"path":["practice_mobilizer_menus"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"19270","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Thu, 27 Apr 2017 07:19:02 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"500\",\"total_count\":\"61\",\"items\":[{\"allow_edit\":\"1\",\"card_code\":\"1019\",\"card_uuid\":\"\",\"child_name\":\"Invite Doctor\",\"has_sub_link\":\"0\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"1\",\"order_id\":\"17\",\"parent\":\"Sage\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Sage\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Invite Doctor\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"1008\",\"card_uuid\":\"\",\"child_name\":\"Accounts Receivable\",\"has_sub_link\":\"0\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"1\",\"order_id\":\"9\",\"parent\":\"Sage\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"Sage\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Accounts Receivable\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"1005\",\"card_uuid\":\"\",\"child_name\":\"Bird Eye\",\"has_sub_link\":\"0\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"1\",\"order_id\":\"7\",\"parent\":\"Sage\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Sage\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Bird Eye\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"1011\",\"card_uuid\":\"\",\"child_name\":\"Day Closing\",\"has_sub_link\":\"0\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"1\",\"order_id\":\"6\",\"parent\":\"Sage\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Sage\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Day Closing\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"1010\",\"card_uuid\":\"\",\"child_name\":\"Morning Report\",\"has_sub_link\":\"0\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"1\",\"order_id\":\"5\",\"parent\":\"Sage\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Sage\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Morning Report\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"1004\",\"card_uuid\":\"\",\"child_name\":\"Provider schedule\",\"has_sub_link\":\"0\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"1\",\"order_id\":\"4\",\"parent\":\"Sage\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Sage\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Provider schedule\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2020\",\"card_uuid\":\"\",\"child_name\":\"Total SRP\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Clinical\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Provider\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2021\",\"card_uuid\":\"\",\"child_name\":\"Prophy\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Clinical\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Provider\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2023\",\"card_uuid\":\"\",\"child_name\":\"Periodic Exams\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Clinical\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Provider\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2025\",\"card_uuid\":\"\",\"child_name\":\"Emergency Exams\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Clinical\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Provider\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2026\",\"card_uuid\":\"\",\"child_name\":\"New patients to Total Patients seen\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Clinical\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Patient\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2027\",\"card_uuid\":\"\",\"child_name\":\"Daily average gross production\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Practice\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Production\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2028\",\"card_uuid\":\"\",\"child_name\":\"Patient Visits\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Clinical\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Patient\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2029\",\"card_uuid\":\"\",\"child_name\":\"Production by Provider\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Practice\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"CY,LY,LLY\",\"sub_parent\":\"Production\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2030\",\"card_uuid\":\"\",\"child_name\":\"Gross and net collection\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Practice\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"CY,LY,LLY\",\"sub_parent\":\"Collection\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2031\",\"card_uuid\":\"\",\"child_name\":\"Daily average net production\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Practice\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Production\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2032\",\"card_uuid\":\"\",\"child_name\":\"Accounts Receivable\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Practice\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"A\\/R\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2033\",\"card_uuid\":\"\",\"child_name\":\"Insurance Claims pending\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Practice\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"A\\/R\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2034\",\"card_uuid\":\"\",\"child_name\":\"Insurance Claims\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Practice\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"A\\/R\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2038\",\"card_uuid\":\"\",\"child_name\":\"Patient Referrals\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Practice\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Patient\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2040\",\"card_uuid\":\"\",\"child_name\":\"Comprehensive exams to new patients\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Clinical\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Procedure\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2041\",\"card_uuid\":\"\",\"child_name\":\"Top 20 Procedures by Production\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Clinical\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Procedure\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2042\",\"card_uuid\":\"\",\"child_name\":\"New Patients Visits\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Clinical\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Patient\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2043\",\"card_uuid\":\"\",\"child_name\":\"Emergency Exams to New Patients\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Clinical\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Procedure\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2044\",\"card_uuid\":\"\",\"child_name\":\"Perio Maintenance by Provider\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Clinical\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Provider\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2046\",\"card_uuid\":\"\",\"child_name\":\"Comprehensive Exams by Provider\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Clinical\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Provider\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"2047\",\"card_uuid\":\"\",\"child_name\":\"Patients Seen\",\"has_sub_link\":\"1\",\"is_free\":\"0\",\"ismarketplacecard\":\"0\",\"menu_order\":\"2\",\"order_id\":\"0\",\"parent\":\"Clinical\",\"parent_logo\":\"KPI\",\"partner_id\":\"\",\"product_code\":\"KPI\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Patient\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3074\",\"card_uuid\":\"0\",\"child_name\":\"Info1\",\"has_sub_link\":\"0\",\"is_free\":\"-1\",\"ismarketplacecard\":\"1\",\"menu_order\":\"3\",\"order_id\":\"28\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"5\",\"product_code\":\"Ideas\",\"service_id\":\"96\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Info1\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3073\",\"card_uuid\":\"\",\"child_name\":\"Fee Survey\",\"has_sub_link\":\"0\",\"is_free\":\"-1\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"27\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Fee Survey\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3072\",\"card_uuid\":\"\",\"child_name\":\"TSI\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"26\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"TSI\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3071\",\"card_uuid\":\"\",\"child_name\":\"Fee Survey Partner\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"25\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"Sikkanet\",\"sub_category\":\"\",\"sub_parent\":\"Fee Survey Partner\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3070\",\"card_uuid\":\"\",\"child_name\":\"Fee Optimizer Partner\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"24\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Fee Optimizer Partner\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3069\",\"card_uuid\":\"\",\"child_name\":\"Review Wave\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"23\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Review Wave\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3068\",\"card_uuid\":\"\",\"child_name\":\"Po\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"22\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Po\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3067\",\"card_uuid\":\"\",\"child_name\":\"Call Optimizer\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"21\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Call Optimizer\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3066\",\"card_uuid\":\"\",\"child_name\":\"CDA\",\"has_sub_link\":\"0\",\"is_free\":\"-1\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"20\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"CDA\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3065\",\"card_uuid\":\"\",\"child_name\":\"71 lbs\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"19\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"71 lbs\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3064\",\"card_uuid\":\"\",\"child_name\":\"Golden proportions\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"18\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Golden proportions\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3063\",\"card_uuid\":\"\",\"child_name\":\"Connect The Doc\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"17\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Connect The Doc\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3062\",\"card_uuid\":\"\",\"child_name\":\"Microdental\",\"has_sub_link\":\"0\",\"is_free\":\"-1\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"16\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Microdental\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3061\",\"card_uuid\":\"\",\"child_name\":\"Patterson\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"15\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Patterson\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3060\",\"card_uuid\":\"\",\"child_name\":\"Call Sumo\",\"has_sub_link\":\"0\",\"is_free\":\"-1\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"14\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Call Sumo\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3059\",\"card_uuid\":\"\",\"child_name\":\"Simplifeye\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"13\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Simplifeye\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3058\",\"card_uuid\":\"\",\"child_name\":\"Testimonial Tree\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"12\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Testimonial Tree\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3057\",\"card_uuid\":\"\",\"child_name\":\"3M\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"11\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"3M\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3056\",\"card_uuid\":\"\",\"child_name\":\"Stratus\",\"has_sub_link\":\"0\",\"is_free\":\"-1\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"10\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Stratus\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3055\",\"card_uuid\":\"\",\"child_name\":\"Smile Source\",\"has_sub_link\":\"0\",\"is_free\":\"-1\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"9\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Smile Source\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3054\",\"card_uuid\":\"\",\"child_name\":\"capital accounts\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"8\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"capital accounts\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3053\",\"card_uuid\":\"\",\"child_name\":\"Google\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"7\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Google\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3052\",\"card_uuid\":\"\",\"child_name\":\"Tek Collect\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"6\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Tek Collect\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3051\",\"card_uuid\":\"\",\"child_name\":\"Microsoft\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"5\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Microsoft\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3050\",\"card_uuid\":\"\",\"child_name\":\"DDX\",\"has_sub_link\":\"0\",\"is_free\":\"-1\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"4\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"DDX\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3049\",\"card_uuid\":\"\",\"child_name\":\"Benco\",\"has_sub_link\":\"0\",\"is_free\":\"-1\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"3\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Benco\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3048\",\"card_uuid\":\"\",\"child_name\":\"Dentsply\",\"has_sub_link\":\"0\",\"is_free\":\"-2\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"2\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Dentsply\",\"user_id\":\"\"},{\"allow_edit\":\"1\",\"card_code\":\"3047\",\"card_uuid\":\"\",\"child_name\":\"Tyson Steele\",\"has_sub_link\":\"0\",\"is_free\":\"-1\",\"ismarketplacecard\":\"0\",\"menu_order\":\"3\",\"order_id\":\"1\",\"parent\":\"Ideas\",\"parent_logo\":\"Card\",\"partner_id\":\"\",\"product_code\":\"Ideas\",\"service_id\":\"\",\"service_name\":\"SikkaNet\",\"sub_category\":\"\",\"sub_parent\":\"Tyson Steele\",\"user_id\":\"\"}]}]\r\n"}],"_postman_id":"4faa91fc-0eb1-44fb-8048-48f319f97ea7"},{"name":"Free fee survey ","id":"d346be2d-0686-4bee-9e62-8ae1fd8aec13","request":{"method":"GET","header":[],"url":"{{authurl}}/free_fee_survey?app_id={{app_id}}&app_key={{app_key}}&email=receiver email&firstname=receiver firstname &lastname=receiver last name&zipcode=valid zipcode","description":"

Fee survey report optimizes your fees on a regular basis. Everything around your practice is constantly changing: the economy, taxes, your competitors’ fees, insurances fees, lab costs and supply expenditures. \nFor more information . visit : [https://storepurchase.sikkasoft.com/Service.html?id=88:80]

\n","urlObject":{"path":["free_fee_survey"],"host":["{{authurl}}"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"},{"key":"email","value":"receiver email"},{"key":"firstname","value":"receiver firstname "},{"key":"lastname","value":"receiver last name"},{"key":"zipcode","value":"valid zipcode"}],"variable":[]}},"response":[{"id":"d984dcea-76f5-4422-82aa-48629a6183b4","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{authurl}}/free_fee_survey?app_id={{app_id}}&app_key={{app_key}}&email=receiver email&firstname=receiver firstname &lastname=receiver last name&zipcode=valid zipcode","host":["{{authurl}}"],"path":["free_fee_survey"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"},{"key":"email","value":"receiver email"},{"key":"firstname","value":"receiver firstname "},{"key":"lastname","value":"receiver last name"},{"key":"zipcode","value":"valid zipcode"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private","name":"Cache-Control","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Length","value":"902","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 03 May 2017 21:46:24 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"500\",\"total_count\":\"10\",\"items\":[{\"code\":\"5110\",\"description\":\"Maxillary Upper Denture\",\"minimum\":\"1700\",\"median\":\"1768\",\"sixtyth\":\"1841\",\"seventyth\":\"1946\",\"eightyth\":\"2103\",\"ninetyth\":\"2265\",\"maximum\":\"2452\",\"zipcode\":\"95035\"},{\"code\":\"7140\",\"description\":\"Extraction' Erupt. Or Exposed (Forceps)\",\"minimum\":\"175\",\"median\":\"185\",\"sixtyth\":\"191\",\"seventyth\":\"199\",\"eightyth\":\"222\",\"ninetyth\":\"244\",\"maximum\":\"282\",\"zipcode\":\"95035\"},{\"code\":\"2752\",\"description\":\"Crown.Proc Fused To Noble Metal\",\"minimum\":\"1040\",\"median\":\"1078\",\"sixtyth\":\"1114\",\"seventyth\":\"1153\",\"eightyth\":\"1203\",\"ninetyth\":\"1299\",\"maximum\":\"1417\",\"zipcode\":\"95035\"},{\"code\":\"1110\",\"description\":\"Prophylaxis - Adult\",\"minimum\":\"97\",\"median\":\"103\",\"sixtyth\":\"105\",\"seventyth\":\"109\",\"eightyth\":\"114\",\"ninetyth\":\"127\",\"maximum\":\"138\",\"zipcode\":\"95035\"},{\"code\":\"3346\",\"description\":\"Retreat Previous Root Canal-Ant\",\"minimum\":\"873\",\"median\":\"922\",\"sixtyth\":\"948\",\"seventyth\":\"989\",\"eightyth\":\"1050\",\"ninetyth\":\"1164\",\"maximum\":\"1284\",\"zipcode\":\"95035\"},{\"code\":\"120\",\"description\":\"Periodic Oral Evaluation\",\"minimum\":\"56\",\"median\":\"61\",\"sixtyth\":\"63\",\"seventyth\":\"65\",\"eightyth\":\"70\",\"ninetyth\":\"78\",\"maximum\":\"89\",\"zipcode\":\"95035\"},{\"code\":\"2392\",\"description\":\"Resin Composite-2 Surfaces' Posterior\",\"minimum\":\"242\",\"median\":\"254\",\"sixtyth\":\"260\",\"seventyth\":\"272\",\"eightyth\":\"289\",\"ninetyth\":\"317\",\"maximum\":\"342\",\"zipcode\":\"95035\"},{\"code\":\"330\",\"description\":\"Panoramic X-RAY\",\"minimum\":\"129\",\"median\":\"135\",\"sixtyth\":\"139\",\"seventyth\":\"145\",\"eightyth\":\"150\",\"ninetyth\":\"162\",\"maximum\":\"173\",\"zipcode\":\"95035\"},{\"code\":\"2331\",\"description\":\"Resin - 2 Surf' Anterior\",\"minimum\":\"206\",\"median\":\"213\",\"sixtyth\":\"223\",\"seventyth\":\"231\",\"eightyth\":\"248\",\"ninetyth\":\"276\",\"maximum\":\"305\",\"zipcode\":\"95035\"},{\"code\":\"2740\",\"description\":\"Crown - All Porcelain\",\"minimum\":\"1140\",\"median\":\"1179\",\"sixtyth\":\"1213\",\"seventyth\":\"1271\",\"eightyth\":\"1328\",\"ninetyth\":\"1449\",\"maximum\":\"1562\",\"zipcode\":\"95035\"}]}]\r\n"}],"_postman_id":"d346be2d-0686-4bee-9e62-8ae1fd8aec13"}],"id":"6ba7c5b8-90b6-4d9d-8f20-a7402977e1b5","description":"

Sikka Practice Mobilizer is an integrated suite of tools offering full control of your practice on your mobile device.For more details : https://practicemobilizer.com/

\n","_postman_id":"6ba7c5b8-90b6-4d9d-8f20-a7402977e1b5"},{"name":"Key Performance Indicators ","item":[{"name":"Key Performance Indicators list","id":"6877cb64-f5ea-423d-845d-5748abb59169","request":{"method":"GET","header":[],"url":"{{url}}/kpis?request_key={{request_key}}","description":"

Key performance indicators will give you the list of all available KPIs for the practice.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes

There are over 300 key performance indicators. \nHere is the few of them

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Sr No	Key Performance Indicators
1	Doctors Gross Production
2	Hygiene Gross Production
3	Doctors Net Production
4	Hygiene Net Production
5	Collection
6	Total AR
7	Total Adjustments
8	Doctor Hours Worked
9	Hygiene Hours Worked
10	New Patients
11	Comprehensive Exams
12	Comprehensive Exams to New Patients
13	Patient Visits
14	New Patients to Patient Visits
15	Recalls
16	Recall Potential
17	Recall Effectiveness
18	# of Patients Reappointed to Hygienist
19	Patients Visited to Hygienist
20	Number of Hygiene Patients
21	Patients Reappointed to Patients Visited
22	Doctors Net Production Per Hour
23	Hygiene Net Production Per Hour
24	Doctors Scheduled Production
25	Hygiene Scheduled Production
26	Hygiene Net Production to Hygiene Scheduled Production
27	Doctor RVU Proficiency
28	Number of Hygiene Days
29	Doctors Net Production to Scheduled Production
30	Hygiene RVU Proficiency
31	FMX
32	Panorex
33	X-Rays to Comprehensive Exams
34	BWX
35	BWX to Prophy
36	Adult Prophy
37	Periodontal Maintenance
38	Perio Maintenance Recall
39	Adult Fluoride
40	Vizilite
41	Total SRP
42	Total Teeth Treated with LAA
43	External Bleaching Per Arch
44	Treatment Planned
45	Treatment Planned Per Comprehensive Exams
46	Gross Production Per Comprehensive Exams
47	Single Crowns
48	Adult Fluoride to Adult Prophy
49	Build Ups
50	Build Ups to Indirect Restorations
51	Total Exams
52	Total Restorations to Comprehensive Exams
53	Hygiene Scheduled Production to Hygiene Net Production
54	Indirect %
55	Total Restorations
56	Total Restorations to Periodic Exams
57	Total Restorations to Total Exams
58	Doctors Average Daily Scheduled Production
59	Doctors Average Daily Net Production
60	Crowns and Bridge
61	4342
62	Total Abutments
63	Amalgams
64	Average Daily Net Production to Average Daily Scheduled Production
65	3 - 4 Surface Direct Restorations
66	Average Daily Scheduled Production to Actual Average Daily Production
67	Total Indirect Restorations
68	Composites
69	Debridement
70	Dentures
71	Desensitization
72	Extractions
73	Total Indirect Restorations to Total Exams
74	Fluoride Varnish
75	Gross Production Per Unique Patients Seen For Comprehensive Exams
76	Gross Production Per Visit
77	FMX by Hygienist
78	Pedo Prophy
79	Hygiene Sealants
80	Hygiene Sealants to Pedo Prophy
81	Inlays
82	Onlays
83	Partials
84	Patients Referred Out
85	Pedo Fluoride
86	Pedo Prophy to Pedo Fluoride
87	Total Pontics
88	Porcelain Veneers
89	Pre-Diagnostic Oral Cancer Test
90	Root Canal Therapy
91	Total Direct Restorations
92	Total Direct Restorations to Comprehensive Exams
93	Total Direct Restorations to Comprehensive Exams and Periodic Exams
94	Total Direct Restorations to Periodic Exams
95	FMX and Panorex
96	Total Indirect Restorations to Comprehensive Exams
97	Total Indirect Restorations to Periodic Exams
98	Total Office Prophies
99	Periodic Exams
100	Total Prophies to Total Fluoride
101	Total SRP to Adult Prophy
102	Total Teeth Treated with LAA to Total Quads of SRP
103	Adult Fluoride Varnish
104	BWX by Hygienist
105	Doctors Chairs Available
106	Treatment Planned Per Unique Patients Seen For Comprehensive Exams
107	3 - 4+ Surface Indirect Restorations
108	Doctors Net Production to Gross Production
109	Gross Production Per Assistant Per Hour
110	Gross Production Per Chair Per Hour
111	Ratio of 3 Months Treatment Acceptance
112	4381
113	4341
114	Total Days Worked
115	Practice Gross Production
116	Practice Net Production
117	Patients Seen by Practice
118	Practice Net Production to Practice Gross Production
119	Collection to Practice Net Production
120	Over the Counter Collection
121	OTC to Total Collections
122	AR Less than 30 days
123	AR 31 to 60 days
124	AR 61 to 90 days
125	AR Above 90 days
126	AR to Gross Production
127	Cash Patients
128	Insurance Patients
129	Cash Patients to Insurance Patients
130	Work Days Per Week
131	Hygiene Unique Patients Recall
132	Active Patients
133	Practice New Patients
134	Avg Patient Seen Per Day by Dentist
135	Avg Patient Seen Per Day by Hygienist
136	Avg Hygiene Days Per Week
137	Number of Patient Referrals
138	Adjunctive General Services Qty by Practice
139	Diagnostic Qty by Practice
140	Endodontics Qty by Practice
141	Implant Services Qty by Practice
142	Maxillofacial Prosthetics Qty by Practice
143	Oral and Maxillofacial Surgery Qty by Practice
144	Orthodontics Qty by Practice
145	Periodontics Qty by Practice
146	Preventive Qty by Practice
147	Prosthodontics (removable) Qty by Practice
148	Prosthodontics fixed Qty by Practice
149	Restorative Qty by Practice
150	Diagnostic Production by Practice
151	Adjunctive General Services Production by Practice
152	Endodontics Production by Practice
153	Implant Services Production by Practice
154	Maxillofacial Prosthetics Production by Practice
155	Oral and Maxillofacial Surgery Production by Practice
156	Orthodontics Production by Practice
157	Periodontics Production by Practice
158	Preventive Production by Practice
159	Prosthodontics (removable) Production by Practice
160	Prosthodontics fixed Production by Practice
161	Restorative Production by Practice
162	Adult Comprehensive Exams
163	Total Adult Exams
164	Adult Fluoride %

","urlObject":{"path":["kpis"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"394c99d1-c5bb-43f6-9bb8-2d9ee3777c1a","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/kpis?request_key={{request_key}}","host":["{{url}}"],"path":["kpis"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"67219","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 12 May 2017 20:22:04 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"500\",\"total_count\":\"360\",\"items\":[{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/# Invoices Generated\",\"category\":\"0\",\"key_performance_indicator\":\"# Invoices Generated\",\"displayname\":\"# Invoices Generated\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/# Invoices Generated Monthly\",\"category\":\"0\",\"key_performance_indicator\":\"# Invoices Generated Monthly\",\"displayname\":\"# Invoices Generated Monthly\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/# of Patients by Procedure Code\",\"category\":\"0\",\"key_performance_indicator\":\"# of Patients by Procedure Code\",\"displayname\":\"# of Patients by Procedure Code\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/# of Patients Seen\",\"category\":\"0\",\"key_performance_indicator\":\"# of Patients Seen\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/# Patients Seen\",\"category\":\"0\",\"key_performance_indicator\":\"# Patients Seen\",\"displayname\":\"# Patients Seen\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/# Procedures\",\"category\":\"0\",\"key_performance_indicator\":\"# Procedures\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/100-400\",\"category\":\"0\",\"key_performance_indicator\":\"100-400\",\"displayname\":\"$100-$400\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/1000-1500\",\"category\":\"0\",\"key_performance_indicator\":\"1000-1500\",\"displayname\":\"$1000-$1500\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/3-4 Surface Dir Rest Trend\",\"category\":\"0\",\"key_performance_indicator\":\"3-4 Surface Dir Rest Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/3-4+ Surface Ind Rest Trend\",\"category\":\"0\",\"key_performance_indicator\":\"3-4+ Surface Ind Rest Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/400-1000\",\"category\":\"0\",\"key_performance_indicator\":\"400-1000\",\"displayname\":\"$400-$1000\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/4341 by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"4341 by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/4381 by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"4381 by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/ABC\",\"category\":\"0\",\"key_performance_indicator\":\"ABC\",\"displayname\":\"ABC\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/ABCbyCost\",\"category\":\"0\",\"key_performance_indicator\":\"ABCbyCost\",\"displayname\":\"ABCbyCost\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/ABCbySales\",\"category\":\"0\",\"key_performance_indicator\":\"ABCbySales\",\"displayname\":\"ABCbySales\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Above 1500\",\"category\":\"0\",\"key_performance_indicator\":\"Above 1500\",\"displayname\":\"Above $1500\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Accounts Receivable\",\"category\":\"0\",\"key_performance_indicator\":\"Accounts Receivable\",\"displayname\":\"Accounts Receivable\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Active Clients Monthly\",\"category\":\"0\",\"key_performance_indicator\":\"Active Clients Monthly\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Active Patient\",\"category\":\"0\",\"key_performance_indicator\":\"Active Patient\",\"displayname\":\"Active Patient\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Active Patients\",\"category\":\"0\",\"key_performance_indicator\":\"Active Patients\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/AdaProduction\",\"category\":\"0\",\"key_performance_indicator\":\"AdaProduction\",\"displayname\":\"Production from ADA Codes\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Adjusted Production\",\"category\":\"0\",\"key_performance_indicator\":\"Adjusted Production\",\"displayname\":\"Net Production\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Adjusted Production by Hygienist\",\"category\":\"0\",\"key_performance_indicator\":\"Adjusted Production by Hygienist\",\"displayname\":\"Adjusted Production by Hygienist\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Adjusted Production by Practice\",\"category\":\"0\",\"key_performance_indicator\":\"Adjusted Production by Practice\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Adjusted Production by Veterinarian\",\"category\":\"0\",\"key_performance_indicator\":\"Adjusted Production by Veterinarian\",\"displayname\":\"Adjusted Production by Veterinarian\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Adult Prophy Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Adult Prophy Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/All Hygienist Patient ReAppointed\",\"category\":\"0\",\"key_performance_indicator\":\"All Hygienist Patient ReAppointed\",\"displayname\":\"All Hygienist Patient ReAppointed\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/All Hygienist Patient Visits\",\"category\":\"0\",\"key_performance_indicator\":\"All Hygienist Patient Visits\",\"displayname\":\"All Hygienist Patient Visits\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Annual Heartworm due for Feline\",\"category\":\"0\",\"key_performance_indicator\":\"Annual Heartworm due for Feline\",\"displayname\":\"Annual_Heartworm_Test_due_for_Feline\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Annual Heartworm Test due for Canine\",\"category\":\"0\",\"key_performance_indicator\":\"Annual Heartworm Test due for Canine\",\"displayname\":\"Annual Heartworm Test due for Canine\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Annual Heartworm Test due for Feline\",\"category\":\"0\",\"key_performance_indicator\":\"Annual Heartworm Test due for Feline\",\"displayname\":\"Annual Heartworm Test due for Cats\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Appointment Hours\",\"category\":\"0\",\"key_performance_indicator\":\"Appointment Hours\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/appointment info\",\"category\":\"0\",\"key_performance_indicator\":\"appointment info\",\"displayname\":\"appointment info\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Appointment Production- Scheduled vs Actual Production\",\"category\":\"0\",\"key_performance_indicator\":\"Appointment Production- Scheduled vs Actual Production\",\"displayname\":\"Appointment Production- Scheduled vs Actual Production\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Appointments By Veterinarian\",\"category\":\"0\",\"key_performance_indicator\":\"Appointments By Veterinarian\",\"displayname\":\"Appointments By Veterinarian\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/AR Details\",\"category\":\"0\",\"key_performance_indicator\":\"AR Details\",\"displayname\":\"AR Details\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/AR31to60\",\"category\":\"0\",\"key_performance_indicator\":\"AR31to60\",\"displayname\":\"AR31to60\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/AR61to90\",\"category\":\"0\",\"key_performance_indicator\":\"AR61to90\",\"displayname\":\"AR61to90\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/ARAbove90\",\"category\":\"0\",\"key_performance_indicator\":\"ARAbove90\",\"displayname\":\"ARAbove90\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/ARInfo\",\"category\":\"0\",\"key_performance_indicator\":\"ARInfo\",\"displayname\":\"0\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/ARLess30\",\"category\":\"0\",\"key_performance_indicator\":\"ARLess30\",\"displayname\":\"ARLess30\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Asset Expense Vital Signs\",\"category\":\"0\",\"key_performance_indicator\":\"Asset Expense Vital Signs\",\"displayname\":\"Asset Expense Vital Signs\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/ATP_Custom\",\"category\":\"0\",\"key_performance_indicator\":\"ATP_Custom\",\"displayname\":\"ATP_Custom\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Average Daily Actual Production to Average Daily Scheduled Production\",\"category\":\"0\",\"key_performance_indicator\":\"Average Daily Actual Production to Average Daily Scheduled Production\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Avg Charge per Pat by Prov\",\"category\":\"0\",\"key_performance_indicator\":\"Avg Charge per Pat by Prov\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Avg Charge per Pat by vet\",\"category\":\"0\",\"key_performance_indicator\":\"Avg Charge per Pat by vet\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Avg prod per pat\",\"category\":\"0\",\"key_performance_indicator\":\"Avg prod per pat\",\"displayname\":\"Avg prod per pat\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/AvgDollarDP\",\"category\":\"0\",\"key_performance_indicator\":\"AvgDollarDP\",\"displayname\":\"AvgDollarDP\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/AvgDollarNDP\",\"category\":\"0\",\"key_performance_indicator\":\"AvgDollarNDP\",\"displayname\":\"AvgDollarNDP\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/AvgVisitDP\",\"category\":\"0\",\"key_performance_indicator\":\"AvgVisitDP\",\"displayname\":\"AvgVisitDP\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/AvgVisitNDP\",\"category\":\"0\",\"key_performance_indicator\":\"AvgVisitNDP\",\"displayname\":\"AvgVisitNDP\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Best Referral Source-Patient Now\",\"category\":\"0\",\"key_performance_indicator\":\"Best Referral Source-Patient Now\",\"displayname\":\"Best Referral Source-Patient Now\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Bitewings by Office Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Bitewings by Office Trend\",\"displayname\":\"0\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Build - Ups by Doctor Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Build - Ups by Doctor Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Business Expenses\",\"category\":\"0\",\"key_performance_indicator\":\"Business Expenses\",\"displayname\":\"Business Expenses\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Catalyst Council\",\"category\":\"0\",\"key_performance_indicator\":\"Catalyst Council\",\"displayname\":\"Catalyst Council\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Claim Paid Amount\",\"category\":\"0\",\"key_performance_indicator\":\"Claim Paid Amount\",\"displayname\":\"Claim Paid Amount\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Claim Patients\",\"category\":\"0\",\"key_performance_indicator\":\"Claim Patients\",\"displayname\":\"Claim Patients\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Clients never purchased therapeutic diet after the initial recommendation\",\"category\":\"0\",\"key_performance_indicator\":\"Clients never purchased therapeutic diet after the initial recommendation\",\"displayname\":\"Clients never purchased therapeutic diet after the initial recommendation\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Clients never purchased therapeutic diet after the initial recommendations\",\"category\":\"0\",\"key_performance_indicator\":\"Clients never purchased therapeutic diet after the initial recommendations\",\"displayname\":\"Clients_never_purchased_therapeutic_diet\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CM_Asset expense\",\"category\":\"0\",\"key_performance_indicator\":\"CM_Asset expense\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CM_Patients Seen\",\"category\":\"0\",\"key_performance_indicator\":\"CM_Patients Seen\",\"displayname\":\"CM_Patients Seen\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CM_Profit and Loss\",\"category\":\"0\",\"key_performance_indicator\":\"CM_Profit and Loss\",\"displayname\":\"CM_Profit and Loss\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CM_Supporting Firms\",\"category\":\"0\",\"key_performance_indicator\":\"CM_Supporting Firms\",\"displayname\":\"CM_Supporting Firms\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Collection By Practice\",\"category\":\"0\",\"key_performance_indicator\":\"Collection By Practice\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Collection by Practice Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Collection by Practice Trend\",\"displayname\":\"0\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Collection to Production\",\"category\":\"0\",\"key_performance_indicator\":\"Collection to Production\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Comprehensive Exams Analysis\",\"category\":\"0\",\"key_performance_indicator\":\"Comprehensive Exams Analysis\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Comprehensive Exams by Doctor Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Comprehensive Exams by Doctor Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Comprehensive Exams to New Patients\",\"category\":\"0\",\"key_performance_indicator\":\"Comprehensive Exams to New Patients\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Core Vaccinations\",\"category\":\"0\",\"key_performance_indicator\":\"Core Vaccinations\",\"displayname\":\"Core_Vaccinations\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Count\",\"category\":\"0\",\"key_performance_indicator\":\"Count\",\"displayname\":\"Top 20 Procedure Count\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Counter Collection\",\"category\":\"0\",\"key_performance_indicator\":\"Counter Collection\",\"displayname\":\"Counter Collection\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Credit\",\"category\":\"0\",\"key_performance_indicator\":\"Credit\",\"displayname\":\"Credit\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Credit Balance\",\"category\":\"0\",\"key_performance_indicator\":\"Credit Balance\",\"displayname\":\"Credit Balance\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Current Profile\",\"category\":\"0\",\"key_performance_indicator\":\"Current Profile\",\"displayname\":\"0\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Asset expense\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Asset expense\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Average Charge per patient by provider\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Average Charge per patient by provider\",\"displayname\":\"CY_Average Charge per patient by provider\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Client Retention Rate\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Client Retention Rate\",\"displayname\":\"CY_Client Retention Rate\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Financial System Accuracy\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Financial System Accuracy\",\"displayname\":\"CY_Financial System Accuracy\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Gross Production\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Gross Production\",\"displayname\":\"CY_Gross Production\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Patients Seen\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Patients Seen\",\"displayname\":\"CY_Patients Seen\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Production by referral sources\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Production by referral sources\",\"displayname\":\"CY_Production by referral sources\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Profit and Loss\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Profit and Loss\",\"displayname\":\"CY_Profit and Loss\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Provider Gross Production\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Provider Gross Production\",\"displayname\":\"CY_Provider Gross Production\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Revenue by Inventory Categories\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Revenue by Inventory Categories\",\"displayname\":\"CY_Revenue by Inventory Categories\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Revenue by treatment categories\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Revenue by treatment categories\",\"displayname\":\"CY_Revenue by treatment categories\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Species Analysis Indicator\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Species Analysis Indicator\",\"displayname\":\"CY_Species Analysis Indicator\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Supporting Firms\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Supporting Firms\",\"displayname\":\"CY_Supporting Firms\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Top 10 Sales Items\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Top 10 Sales Items\",\"displayname\":\"CY_Top 10 Sales Items\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/CY_Total Collection\",\"category\":\"0\",\"key_performance_indicator\":\"CY_Total Collection\",\"displayname\":\"CY_Total Collection\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Daily Board Provider Production\",\"category\":\"0\",\"key_performance_indicator\":\"Daily Board Provider Production\",\"displayname\":\"Daily Board Provider Production\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Daily Revenue & Expenses\",\"category\":\"0\",\"key_performance_indicator\":\"Daily Revenue & Expenses\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/DDS Visits\",\"category\":\"0\",\"key_performance_indicator\":\"DDS Visits\",\"displayname\":\"Dentist Patient Visits\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Debit\",\"category\":\"0\",\"key_performance_indicator\":\"Debit\",\"displayname\":\"Debit\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Definition Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Definition Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Dental Cleaning\",\"category\":\"0\",\"key_performance_indicator\":\"Dental Cleaning\",\"displayname\":\"Dental_Cleaning\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Dental Cleanings\",\"category\":\"0\",\"key_performance_indicator\":\"Dental Cleanings\",\"displayname\":\"Dental_Cleaning\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Dental Pharma_Custom\",\"category\":\"0\",\"key_performance_indicator\":\"Dental Pharma_Custom\",\"displayname\":\"Dental Pharma_Custom\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Dental Pharma_Custom\",\"category\":\"0\",\"key_performance_indicator\":\"Dental Pharma_Custom\",\"displayname\":\"Dental Pharma_Custom\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Dental Procedures\",\"category\":\"0\",\"key_performance_indicator\":\"Dental Procedures\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Dental Revenue\",\"category\":\"0\",\"key_performance_indicator\":\"Dental Revenue\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Dental Revenue_Custom\",\"category\":\"0\",\"key_performance_indicator\":\"Dental Revenue_Custom\",\"displayname\":\"Dental Revenue_Custom\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Dental Supplies\",\"category\":\"0\",\"key_performance_indicator\":\"Dental Supplies\",\"displayname\":\"Dental Supplies\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Dental Supplies_Custom\",\"category\":\"0\",\"key_performance_indicator\":\"Dental Supplies_Custom\",\"displayname\":\"Dental Supplies_Custom\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Dentist Adjusted Production\",\"category\":\"0\",\"key_performance_indicator\":\"Dentist Adjusted Production\",\"displayname\":\"Dentist Adjusted Production\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Dentist Scheduled Production Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Dentist Scheduled Production Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Descretionary Costs\",\"category\":\"0\",\"key_performance_indicator\":\"Descretionary Costs\",\"displayname\":\"Descretionary Costs\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Doctor Worked Days\",\"category\":\"0\",\"key_performance_indicator\":\"Doctor Worked Days\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Doctors Hours Worked\",\"category\":\"0\",\"key_performance_indicator\":\"Doctors Hours Worked\",\"displayname\":\"Doctors Hours Worked\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Doctors Worked Days\",\"category\":\"0\",\"key_performance_indicator\":\"Doctors Worked Days\",\"displayname\":\"Doctors Worked Days\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Early Diagnosis\",\"category\":\"0\",\"key_performance_indicator\":\"Early Diagnosis\",\"displayname\":\"Early_Diagnosis_-_Wellness_Exams\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Expenses\",\"category\":\"0\",\"key_performance_indicator\":\"Expenses\",\"displayname\":\"Expenses\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/External Referral Source-Patient Now\",\"category\":\"0\",\"key_performance_indicator\":\"External Referral Source-Patient Now\",\"displayname\":\"External Referral Source-Patient Now\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Facility and Equipment Costs\",\"category\":\"0\",\"key_performance_indicator\":\"Facility and Equipment Costs\",\"displayname\":\"Facility and Equipment Costs\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Fecal Test\",\"category\":\"0\",\"key_performance_indicator\":\"Fecal Test\",\"displayname\":\"Fecal_Test\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Fecal Testing\",\"category\":\"0\",\"key_performance_indicator\":\"Fecal Testing\",\"displayname\":\"Fecal_Testing\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Final McKenzie\",\"category\":\"0\",\"key_performance_indicator\":\"Final McKenzie\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/FMX by Office Trend\",\"category\":\"0\",\"key_performance_indicator\":\"FMX by Office Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Fortune Management Report\",\"category\":\"0\",\"key_performance_indicator\":\"Fortune Management Report\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Gross Production\",\"category\":\"0\",\"key_performance_indicator\":\"Gross Production\",\"displayname\":\"Gross Production\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Gross Production by Groomer Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Gross Production by Groomer Trend\",\"displayname\":\"Gross Production by Groomer Trend\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Gross Production by Practice\",\"category\":\"0\",\"key_performance_indicator\":\"Gross Production by Practice\",\"displayname\":\"Gross Production by Practice\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Gross Production by Practice Monthly\",\"category\":\"0\",\"key_performance_indicator\":\"Gross Production by Practice Monthly\",\"displayname\":\"Gross Production by Practice Monthly\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Gross Production by Practice Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Gross Production by Practice Trend\",\"displayname\":\"0\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Gross Production By Procedures Category\",\"category\":\"0\",\"key_performance_indicator\":\"Gross Production By Procedures Category\",\"displayname\":\"Gross Production By Procedures Category\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Gross Production by Provider\",\"category\":\"0\",\"key_performance_indicator\":\"Gross Production by Provider\",\"displayname\":\"Gross Production by Provider in $\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Gross Production by Referral Source\",\"category\":\"0\",\"key_performance_indicator\":\"Gross Production by Referral Source\",\"displayname\":\"Gross Production by Referral Source\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Gross Production by Veterinarian Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Gross Production by Veterinarian Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Gross Production by Veterinary Technician Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Gross Production by Veterinary Technician Trend\",\"displayname\":\"Gross Production by Veterinary Technician Trend\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Heartworm Testing\",\"category\":\"0\",\"key_performance_indicator\":\"Heartworm Testing\",\"displayname\":\"Heartworm_Testing_-_Canine_and_Feline\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Hours Worked by Doctor Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Hours Worked by Doctor Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Hours Worked by Hygien Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Hours Worked by Hygien Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Hyg RVU factor Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Hyg RVU factor Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Hyg Visits\",\"category\":\"0\",\"key_performance_indicator\":\"Hyg Visits\",\"displayname\":\"Hyg Visits\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Hygiene Scheduled Production Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Hygiene Scheduled Production Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Hygiene Unique Patients Recall\",\"category\":\"0\",\"key_performance_indicator\":\"Hygiene Unique Patients Recall\",\"displayname\":\"Hygiene Unique Patients Recall\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Hygienist Adjusted Production\",\"category\":\"0\",\"key_performance_indicator\":\"Hygienist Adjusted Production\",\"displayname\":\"Hygienist Adjusted Production\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Hygienist Worked Days\",\"category\":\"0\",\"key_performance_indicator\":\"Hygienist Worked Days\",\"displayname\":\"Hygienist Worked Days\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Hygienists Salary\",\"category\":\"0\",\"key_performance_indicator\":\"Hygienists Salary\",\"displayname\":\"Hygienists Salary\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/HygienPerformance\",\"category\":\"0\",\"key_performance_indicator\":\"HygienPerformance\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/HygMMRDefinitions\",\"category\":\"0\",\"key_performance_indicator\":\"HygMMRDefinitions\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Inactive clients-Patient Now\",\"category\":\"0\",\"key_performance_indicator\":\"Inactive clients-Patient Now\",\"displayname\":\"Inactive Clients\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Indirect Restoration by Doctor Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Indirect Restoration by Doctor Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/InsCompanyName\",\"category\":\"0\",\"key_performance_indicator\":\"InsCompanyName\",\"displayname\":\"InsCompanyName\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Insurance Claim Agings\",\"category\":\"0\",\"key_performance_indicator\":\"Insurance Claim Agings\",\"displayname\":\"Insurance Claim Agings\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Insurance Details\",\"category\":\"0\",\"key_performance_indicator\":\"Insurance Details\",\"displayname\":\"Insurance Details\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Insurance Fee Production\",\"category\":\"0\",\"key_performance_indicator\":\"Insurance Fee Production\",\"displayname\":\"Insurance Fee Production\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LAA 1site\\/tooth by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"LAA 1site\\/tooth by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LAA 2 sites\\/tooth by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"LAA 2 sites\\/tooth by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LAA 3 sites\\/tooth by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"LAA 3 sites\\/tooth by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LAA 4 sites\\/tooth by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"LAA 4 sites\\/tooth by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LAA 5 sites\\/tooth by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"LAA 5 sites\\/tooth by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LAA 6 sites\\/tooth by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"LAA 6 sites\\/tooth by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LAA Total by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"LAA Total by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Lapsing Patient\",\"category\":\"0\",\"key_performance_indicator\":\"Lapsing Patient\",\"displayname\":\"Lapsing_Patients\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Last PaymentAmount And Date\",\"category\":\"0\",\"key_performance_indicator\":\"Last PaymentAmount And Date\",\"displayname\":\"Last PaymentAmount And Date\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LLY_Average Charge per patient by provider\",\"category\":\"0\",\"key_performance_indicator\":\"LLY_Average Charge per patient by provider\",\"displayname\":\"LLY_Average Charge per patient by provider\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LLY_Client Retention Rate\",\"category\":\"0\",\"key_performance_indicator\":\"LLY_Client Retention Rate\",\"displayname\":\"LLY_Client Retention Rate\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LLY_Financial System Accuracy\",\"category\":\"0\",\"key_performance_indicator\":\"LLY_Financial System Accuracy\",\"displayname\":\"LLY_Financial System Accuracy\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LLY_Gross Production\",\"category\":\"0\",\"key_performance_indicator\":\"LLY_Gross Production\",\"displayname\":\"LLY_Gross Production\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LLY_Production by referral sources\",\"category\":\"0\",\"key_performance_indicator\":\"LLY_Production by referral sources\",\"displayname\":\"LLY_Production by referral sources\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LLY_Provider Gross Production\",\"category\":\"0\",\"key_performance_indicator\":\"LLY_Provider Gross Production\",\"displayname\":\"LLY_Provider Gross Production\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LLY_Revenue by Inventory Categories\",\"category\":\"0\",\"key_performance_indicator\":\"LLY_Revenue by Inventory Categories\",\"displayname\":\"LLY_Revenue by Inventory Categories\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LLY_Revenue by treatment categories\",\"category\":\"0\",\"key_performance_indicator\":\"LLY_Revenue by treatment categories\",\"displayname\":\"LLY_Revenue by treatment categories\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LLY_Species Analysis Indicator\",\"category\":\"0\",\"key_performance_indicator\":\"LLY_Species Analysis Indicator\",\"displayname\":\"LLY_Species Analysis Indicator\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LLY_Top 10 Sales Items\",\"category\":\"0\",\"key_performance_indicator\":\"LLY_Top 10 Sales Items\",\"displayname\":\"LLY_Top 10 Sales Items\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LLY_Total Collection\",\"category\":\"0\",\"key_performance_indicator\":\"LLY_Total Collection\",\"displayname\":\"LLY_Total Collection\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Asset expense\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Asset expense\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Average Charge per patient by provider\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Average Charge per patient by provider\",\"displayname\":\"LY_Average Charge per patient by provider\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Client Retention Rate\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Client Retention Rate\",\"displayname\":\"LY_Client Retention Rate\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Financial System Accuracy\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Financial System Accuracy\",\"displayname\":\"LY_Financial System Accuracy\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Gross Production\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Gross Production\",\"displayname\":\"LY_Gross Production\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Patients Seen\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Patients Seen\",\"displayname\":\"LY_Patients Seen\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Production by referral sources\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Production by referral sources\",\"displayname\":\"LY_Production by referral sources\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Profit and Loss\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Profit and Loss\",\"displayname\":\"LY_Profit and Loss\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Provider Gross Production\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Provider Gross Production\",\"displayname\":\"LY_Provider Gross Production\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Revenue by Inventory Categories\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Revenue by Inventory Categories\",\"displayname\":\"LY_Revenue by Inventory Categories\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Revenue by treatment categories\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Revenue by treatment categories\",\"displayname\":\"LY_Revenue by treatment categories\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Species Analysis Indicator\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Species Analysis Indicator\",\"displayname\":\"LY_Species Analysis Indicator\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Supporting Firms\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Supporting Firms\",\"displayname\":\"LY_Supporting Firms\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Top 10 Sales Items\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Top 10 Sales Items\",\"displayname\":\"LY_Top 10 Sales Items\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/LY_Total Collection\",\"category\":\"0\",\"key_performance_indicator\":\"LY_Total Collection\",\"displayname\":\"LY_Total Collection\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Marketing\",\"category\":\"0\",\"key_performance_indicator\":\"Marketing\",\"displayname\":\"Marketing\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Midmark\",\"category\":\"0\",\"key_performance_indicator\":\"Midmark\",\"displayname\":\"Midmark\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Missed Recare Last Year\",\"category\":\"0\",\"key_performance_indicator\":\"Missed Recare Last Year\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Missing dental checkup for all animals\",\"category\":\"0\",\"key_performance_indicator\":\"Missing dental checkup for all animals\",\"displayname\":\"Missing dental checkup for all animals\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Missing dental checkups for all animals\",\"category\":\"0\",\"key_performance_indicator\":\"Missing dental checkups for all animals\",\"displayname\":\"Missing_dental_checkups_for_all_animals\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Missing Fecal test for all animals\",\"category\":\"0\",\"key_performance_indicator\":\"Missing Fecal test for all animals\",\"displayname\":\"Missing Fecal test for all animals\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Missing Fecal tests for all animals\",\"category\":\"0\",\"key_performance_indicator\":\"Missing Fecal tests for all animals\",\"displayname\":\"Missing_Fecal_tests_for_all_animals\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Missing vaccination information for all animals\",\"category\":\"0\",\"key_performance_indicator\":\"Missing vaccination information for all animals\",\"displayname\":\"Missing_vaccination_information_for_all_animals\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Missing vaccine information for all animals\",\"category\":\"0\",\"key_performance_indicator\":\"Missing vaccine information for all animals\",\"displayname\":\"Missing vaccine information for all animals\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Net adj. production Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Net adj. production Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Net Dentist Production Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Net Dentist Production Trend\",\"displayname\":\"0\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Net Hygiene Production Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Net Hygiene Production Trend\",\"displayname\":\"0\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Net Patient AR\",\"category\":\"0\",\"key_performance_indicator\":\"Net Patient AR\",\"displayname\":\"Net Patient AR\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Net Production by Practice\",\"category\":\"0\",\"key_performance_indicator\":\"Net Production by Practice\",\"displayname\":\"Net Production by Practice\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Net Production by Practice Monthly\",\"category\":\"0\",\"key_performance_indicator\":\"Net Production by Practice Monthly\",\"displayname\":\"Net Production by Practice Monthly\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Net Production by Practice Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Net Production by Practice Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/New Clients\",\"category\":\"0\",\"key_performance_indicator\":\"New Clients\",\"displayname\":\"New Clients\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/New Clients by Practice\",\"category\":\"0\",\"key_performance_indicator\":\"New Clients by Practice\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/New Clients Trend\",\"category\":\"0\",\"key_performance_indicator\":\"New Clients Trend\",\"displayname\":\"New Clients\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/New Patient Trend\",\"category\":\"0\",\"key_performance_indicator\":\"New Patient Trend\",\"displayname\":\"New Patient Trend\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/New Patient(s)\",\"category\":\"0\",\"key_performance_indicator\":\"New Patient(s)\",\"displayname\":\"New Patient(s)\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/New Patients by Doctor Trend\",\"category\":\"0\",\"key_performance_indicator\":\"New Patients by Doctor Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/New Patients by Practice\",\"category\":\"0\",\"key_performance_indicator\":\"New Patients by Practice\",\"displayname\":\"New Patients by Practice\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/No Show Last Year\",\"category\":\"0\",\"key_performance_indicator\":\"No Show Last Year\",\"displayname\":\"No Show Last Year\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/No Shows\",\"category\":\"0\",\"key_performance_indicator\":\"No Shows\",\"displayname\":\"No Shows\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/NoOfPaydingTreatmentPlan\",\"category\":\"0\",\"key_performance_indicator\":\"NoOfPaydingTreatmentPlan\",\"displayname\":\"NoOfPaydingTreatmentPlan\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/NoShow and Future\",\"category\":\"0\",\"key_performance_indicator\":\"NoShow and Future\",\"displayname\":\"NoShow and Future\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Number of Patient Visits by provider\",\"category\":\"0\",\"key_performance_indicator\":\"Number of Patient Visits by provider\",\"displayname\":\"Number of Patient Visits\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/OFC Adjusted Production vs. Collection Tracker\",\"category\":\"0\",\"key_performance_indicator\":\"OFC Adjusted Production vs. Collection Tracker\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Office Supplies\",\"category\":\"0\",\"key_performance_indicator\":\"Office Supplies\",\"displayname\":\"Office Supplies\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Out Ins Aging\",\"category\":\"0\",\"key_performance_indicator\":\"Out Ins Aging\",\"displayname\":\"Out Ins Aging\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Outstanding Claim Amount\",\"category\":\"0\",\"key_performance_indicator\":\"Outstanding Claim Amount\",\"displayname\":\"Outstanding Claim Amount\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Overheads to Total Collection\",\"category\":\"0\",\"key_performance_indicator\":\"Overheads to Total Collection\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Owners Compensation\",\"category\":\"0\",\"key_performance_indicator\":\"Owners Compensation\",\"displayname\":\"Owners Compensation\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Panorex by Office Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Panorex by Office Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient 360 Last Appointment Date\",\"category\":\"0\",\"key_performance_indicator\":\"Patient 360 Last Appointment Date\",\"displayname\":\"Patient 360 Last Appointment Date\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient 360 Next Appointment Date\",\"category\":\"0\",\"key_performance_indicator\":\"Patient 360 Next Appointment Date\",\"displayname\":\"Patient 360 Next Appointment Date\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient 360 OtherRef\",\"category\":\"0\",\"key_performance_indicator\":\"Patient 360 OtherRef\",\"displayname\":\"Patient 360 OtherRef\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient 360 PatID Search\",\"category\":\"0\",\"key_performance_indicator\":\"Patient 360 PatID Search\",\"displayname\":\"Patient 360 PatID Search\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient 360 PatName Search\",\"category\":\"0\",\"key_performance_indicator\":\"Patient 360 PatName Search\",\"displayname\":\"Patient 360 PatName Search\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient 360 Personal Details\",\"category\":\"0\",\"key_performance_indicator\":\"Patient 360 Personal Details\",\"displayname\":\"Patient 360 Personal Details\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient 360 Reference by\",\"category\":\"0\",\"key_performance_indicator\":\"Patient 360 Reference by\",\"displayname\":\"Patient 360 Reference by\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient 360 Reference to\",\"category\":\"0\",\"key_performance_indicator\":\"Patient 360 Reference to\",\"displayname\":\"Patient 360 Reference to\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient 360 RefOut\",\"category\":\"0\",\"key_performance_indicator\":\"Patient 360 RefOut\",\"displayname\":\"Patient 360 RefOut\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient 360 Total Amount\",\"category\":\"0\",\"key_performance_indicator\":\"Patient 360 Total Amount\",\"displayname\":\"Patient 360 Total Amount\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient Family Member\",\"category\":\"0\",\"key_performance_indicator\":\"Patient Family Member\",\"displayname\":\"Patient Family Member\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient Group Plan\",\"category\":\"0\",\"key_performance_indicator\":\"Patient Group Plan\",\"displayname\":\"Patient Group Plan\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient Notes\",\"category\":\"0\",\"key_performance_indicator\":\"Patient Notes\",\"displayname\":\"Patient Notes\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Patient Visits Practice Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Patient Visits Practice Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/PayPlanAmt\",\"category\":\"0\",\"key_performance_indicator\":\"PayPlanAmt\",\"displayname\":\"PayPlanAmt\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/per client\",\"category\":\"0\",\"key_performance_indicator\":\"per client\",\"displayname\":\"per client\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/per invoice\",\"category\":\"0\",\"key_performance_indicator\":\"per invoice\",\"displayname\":\"per invoice\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/per patient\",\"category\":\"0\",\"key_performance_indicator\":\"per patient\",\"displayname\":\"per patient\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Perio Maintenance by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Perio Maintenance by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Personnel Costs\",\"category\":\"0\",\"key_performance_indicator\":\"Personnel Costs\",\"displayname\":\"Personnel Costs\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Practice Overheads\",\"category\":\"0\",\"key_performance_indicator\":\"Practice Overheads\",\"displayname\":\"Practice Overheads\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Pre-Diagnostic Oral Cancer Test by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Pre-Diagnostic Oral Cancer Test by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/prediction\",\"category\":\"0\",\"key_performance_indicator\":\"prediction\",\"displayname\":\"prediction\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/prediction result\",\"category\":\"0\",\"key_performance_indicator\":\"prediction result\",\"displayname\":\"prediction result\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Procedure Frequency\",\"category\":\"0\",\"key_performance_indicator\":\"Procedure Frequency\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Procedures Category Analysis\",\"category\":\"0\",\"key_performance_indicator\":\"Procedures Category Analysis\",\"displayname\":\"Procedures Category Analysis\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Production\",\"category\":\"0\",\"key_performance_indicator\":\"Production\",\"displayname\":\"Top 20 Procedure Production\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Production and Collection\",\"category\":\"0\",\"key_performance_indicator\":\"Production and Collection\",\"displayname\":\"Production and Collection\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Production by CDT Category\",\"category\":\"0\",\"key_performance_indicator\":\"Production by CDT Category\",\"displayname\":\"Production by CDT Category\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Production By Referral Source\",\"category\":\"0\",\"key_performance_indicator\":\"Production By Referral Source\",\"displayname\":\"Production By Referral Source\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Production Per Day\",\"category\":\"0\",\"key_performance_indicator\":\"Production Per Day\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Profile\",\"category\":\"0\",\"key_performance_indicator\":\"Profile\",\"displayname\":\"Profile\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Providers Adjusted Production\",\"category\":\"0\",\"key_performance_indicator\":\"Providers Adjusted Production\",\"displayname\":\"Providers Adjusted Production\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Providers Gross Production\",\"category\":\"0\",\"key_performance_indicator\":\"Providers Gross Production\",\"displayname\":\"Providers Gross Production\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Reactivate Inactive Patients\",\"category\":\"0\",\"key_performance_indicator\":\"Reactivate Inactive Patients\",\"displayname\":\"Reactivate Inactive Clients\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Recall Potential by Office Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Recall Potential by Office Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Recalls by Office Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Recalls by Office Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Recent Patient\",\"category\":\"0\",\"key_performance_indicator\":\"Recent Patient\",\"displayname\":\"Recent Patient\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Referral Source Report\",\"category\":\"0\",\"key_performance_indicator\":\"Referral Source Report\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Retention Clients Monthly\",\"category\":\"0\",\"key_performance_indicator\":\"Retention Clients Monthly\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Return on investment table1\",\"category\":\"0\",\"key_performance_indicator\":\"Return on investment table1\",\"displayname\":\"0\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Return on investment table2\",\"category\":\"0\",\"key_performance_indicator\":\"Return on investment table2\",\"displayname\":\"0\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Revenue by Inventory Category\",\"category\":\"0\",\"key_performance_indicator\":\"Revenue by Inventory Category\",\"displayname\":\"Revenue by Inventory Category\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Revenue by Inventory Sale\",\"category\":\"0\",\"key_performance_indicator\":\"Revenue by Inventory Sale\",\"displayname\":\"Revenue by Inventory Sale\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Revenue By Retail Sales\",\"category\":\"0\",\"key_performance_indicator\":\"Revenue By Retail Sales\",\"displayname\":\"Revenue By Retail Sales\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Revenue By Treatment Category\",\"category\":\"0\",\"key_performance_indicator\":\"Revenue By Treatment Category\",\"displayname\":\"Revenue By Treatment Category\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Royal Canin_Custom\",\"category\":\"0\",\"key_performance_indicator\":\"Royal Canin_Custom\",\"displayname\":\"Royal Canin_Custom\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/rptMTDPractice\",\"category\":\"0\",\"key_performance_indicator\":\"rptMTDPractice\",\"displayname\":\"rptMTDPractice\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/rptMTDProvider\",\"category\":\"0\",\"key_performance_indicator\":\"rptMTDProvider\",\"displayname\":\"0\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/rptMTDProvScheduled\",\"category\":\"0\",\"key_performance_indicator\":\"rptMTDProvScheduled\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/rptPatientDetails\",\"category\":\"0\",\"key_performance_indicator\":\"rptPatientDetails\",\"displayname\":\"0\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/rptPracticeDetails\",\"category\":\"0\",\"key_performance_indicator\":\"rptPracticeDetails\",\"displayname\":\"0\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/rptProcedureDetails\",\"category\":\"0\",\"key_performance_indicator\":\"rptProcedureDetails\",\"displayname\":\"0\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/rptTDInactivePat\",\"category\":\"0\",\"key_performance_indicator\":\"rptTDInactivePat\",\"displayname\":\"0\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/rptWAGPractice\",\"category\":\"0\",\"key_performance_indicator\":\"rptWAGPractice\",\"displayname\":\"0\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/rptWAGProvider\",\"category\":\"0\",\"key_performance_indicator\":\"rptWAGProvider\",\"displayname\":\"0\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/RVU factor by Doctor Trend\",\"category\":\"0\",\"key_performance_indicator\":\"RVU factor by Doctor Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Schedule Production\",\"category\":\"0\",\"key_performance_indicator\":\"Schedule Production\",\"displayname\":\"Schedule Production\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Scheduled Production\",\"category\":\"0\",\"key_performance_indicator\":\"Scheduled Production\",\"displayname\":\"Scheduled Production\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Sikka Tracker\",\"category\":\"0\",\"key_performance_indicator\":\"Sikka Tracker\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Species Analysis\",\"category\":\"0\",\"key_performance_indicator\":\"Species Analysis\",\"displayname\":\"Species Analysis\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/SRP Type 2 by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"SRP Type 2 by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/SRP Type 3 by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"SRP Type 3 by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/SRP Type 4 by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"SRP Type 4 by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Staff Salary\",\"category\":\"0\",\"key_performance_indicator\":\"Staff Salary\",\"displayname\":\"Staff Salary\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Supporting Firms Analysis\",\"category\":\"0\",\"key_performance_indicator\":\"Supporting Firms Analysis\",\"displayname\":\"Supporting Firms Analysis\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Target Profile\",\"category\":\"0\",\"key_performance_indicator\":\"Target Profile\",\"displayname\":\"0\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TDAppt\",\"category\":\"0\",\"key_performance_indicator\":\"TDAppt\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TDApptHr\",\"category\":\"0\",\"key_performance_indicator\":\"TDApptHr\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TDApptHyg\",\"category\":\"0\",\"key_performance_indicator\":\"TDApptHyg\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TDApptPM\",\"category\":\"0\",\"key_performance_indicator\":\"TDApptPM\",\"displayname\":\"TDApptPM\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TDNewPatients\",\"category\":\"0\",\"key_performance_indicator\":\"TDNewPatients\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TDPatFamilyHygAppt\",\"category\":\"0\",\"key_performance_indicator\":\"TDPatFamilyHygAppt\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TDPatientNote\",\"category\":\"0\",\"key_performance_indicator\":\"TDPatientNote\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TDPatInactPM\",\"category\":\"0\",\"key_performance_indicator\":\"TDPatInactPM\",\"displayname\":\"TDPatInactPM\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TDPatLastVisit\",\"category\":\"0\",\"key_performance_indicator\":\"TDPatLastVisit\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TDTreatPlans\",\"category\":\"0\",\"key_performance_indicator\":\"TDTreatPlans\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TDTreatPlansHyg\",\"category\":\"0\",\"key_performance_indicator\":\"TDTreatPlansHyg\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Therapeutic Diet Potential\",\"category\":\"0\",\"key_performance_indicator\":\"Therapeutic Diet Potential\",\"displayname\":\"Therapeutic_Diet_Potential\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Thyroid Panel Test due 5 years old Canine\",\"category\":\"0\",\"key_performance_indicator\":\"Thyroid Panel Test due 5 years old Canine\",\"displayname\":\"Thyroid_Panel_Test_5_years_old_Canine\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Thyroid Panel Test due 5 years old Feline\",\"category\":\"0\",\"key_performance_indicator\":\"Thyroid Panel Test due 5 years old Feline\",\"displayname\":\"Thyroid_Panel_Test_5_years_old_Feline\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Thyroid Panel Test due of all above 5 years old Canine\",\"category\":\"0\",\"key_performance_indicator\":\"Thyroid Panel Test due of all above 5 years old Canine\",\"displayname\":\"Thyroid Panel Test due of all above 5 years old Canine\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Thyroid Panel Test due of all above 5 years old Feline\",\"category\":\"0\",\"key_performance_indicator\":\"Thyroid Panel Test due of all above 5 years old Feline\",\"displayname\":\"Thyroid Panel Test due of all above 5 years old Feline\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Today Appointment\",\"category\":\"0\",\"key_performance_indicator\":\"Today Appointment\",\"displayname\":\"Today Appointment\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Today Appointment Details\",\"category\":\"0\",\"key_performance_indicator\":\"Today Appointment Details\",\"displayname\":\"Today Appointment Details\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Today Birthday\",\"category\":\"0\",\"key_performance_indicator\":\"Today Birthday\",\"displayname\":\"Today Birthday\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Top 20 Procedure Count\",\"category\":\"0\",\"key_performance_indicator\":\"Top 20 Procedure Count\",\"displayname\":\"Top 20 Procedure Count\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Top 20 Procedure Production\",\"category\":\"0\",\"key_performance_indicator\":\"Top 20 Procedure Production\",\"displayname\":\"Top 20 Procedure Production\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Top 5 Collection\",\"category\":\"0\",\"key_performance_indicator\":\"Top 5 Collection\",\"displayname\":\"Top 5 Collection\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Top 5 Production\",\"category\":\"0\",\"key_performance_indicator\":\"Top 5 Production\",\"displayname\":\"Top 5 Production\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total AR\",\"category\":\"0\",\"key_performance_indicator\":\"Total AR\",\"displayname\":\"Total AR\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total AR by Practice Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Total AR by Practice Trend\",\"displayname\":\"Total Accounts Receivable\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total Client Transactions\",\"category\":\"0\",\"key_performance_indicator\":\"Total Client Transactions\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total Clients by Practice\",\"category\":\"0\",\"key_performance_indicator\":\"Total Clients by Practice\",\"displayname\":\"Total Clients by Practice\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total Clients by Practice Monthly\",\"category\":\"0\",\"key_performance_indicator\":\"Total Clients by Practice Monthly\",\"displayname\":\"Total Clients by Practice Monthly\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total Collection\",\"category\":\"0\",\"key_performance_indicator\":\"Total Collection\",\"displayname\":\"Total Collection\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total Indirect Restorations by Doctor\",\"category\":\"0\",\"key_performance_indicator\":\"Total Indirect Restorations by Doctor\",\"displayname\":\"Total Indirect Restorations\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total Insurance Claims Pending Greater than 30 Days to Total Insurance Claims Pending\",\"category\":\"0\",\"key_performance_indicator\":\"Total Insurance Claims Pending Greater than 30 Days to Total Insurance Claims Pending\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total No Show To Total Patient Appointed\",\"category\":\"0\",\"key_performance_indicator\":\"Total No Show To Total Patient Appointed\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total Patients\",\"category\":\"0\",\"key_performance_indicator\":\"Total Patients\",\"displayname\":\"Total Patients\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total Patients Referral to Total Active Patients\",\"category\":\"0\",\"key_performance_indicator\":\"Total Patients Referral to Total Active Patients\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total Procedures by Providers\",\"category\":\"0\",\"key_performance_indicator\":\"Total Procedures by Providers\",\"displayname\":\"Total Procedures by Providers\",\"type\":\"#\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total SRP by Hygienist Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Total SRP by Hygienist Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total TP\",\"category\":\"0\",\"key_performance_indicator\":\"Total TP\",\"displayname\":\"Total TP\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total Transactions\",\"category\":\"0\",\"key_performance_indicator\":\"Total Transactions\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Total Unique Patients Treatment Plan Scheduled to Total Unique Patients Treatment Plan Created\",\"category\":\"0\",\"key_performance_indicator\":\"Total Unique Patients Treatment Plan Scheduled to Total Unique Patients Treatment Plan Created\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TotalOutstandingClaim\",\"category\":\"0\",\"key_performance_indicator\":\"TotalOutstandingClaim\",\"displayname\":\"TotalOutstandingClaim\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TotalOutstandingClaim 1\",\"category\":\"0\",\"key_performance_indicator\":\"TotalOutstandingClaim 1\",\"displayname\":\"TotalOutstandingClaim 1\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TP 31-60\",\"category\":\"0\",\"key_performance_indicator\":\"TP 31-60\",\"displayname\":\"TP 31-60\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TP 61-90\",\"category\":\"0\",\"key_performance_indicator\":\"TP 61-90\",\"displayname\":\"TP 61-90\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TP >90\",\"category\":\"0\",\"key_performance_indicator\":\"TP >90\",\"displayname\":\"TP >90\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TP by ProcedureCode\",\"category\":\"0\",\"key_performance_indicator\":\"TP by ProcedureCode\",\"displayname\":\"TP by ProcedureCode\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TP by Provider\",\"category\":\"0\",\"key_performance_indicator\":\"TP by Provider\",\"displayname\":\"TP by Provider\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TP<30\",\"category\":\"0\",\"key_performance_indicator\":\"TP<30\",\"displayname\":\"TP<30\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Tracker\",\"category\":\"0\",\"key_performance_indicator\":\"Tracker\",\"displayname\":\"Tracker\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/TreatmentPlanned\",\"category\":\"0\",\"key_performance_indicator\":\"TreatmentPlanned\",\"displayname\":\"TreatmentPlanned\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Twice-yearly exams\",\"category\":\"0\",\"key_performance_indicator\":\"Twice-yearly exams\",\"displayname\":\"Twice-yearly exams\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/UCR Fee Production\",\"category\":\"0\",\"key_performance_indicator\":\"UCR Fee Production\",\"displayname\":\"UCR Fee Production\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Unique Pets Seen\",\"category\":\"0\",\"key_performance_indicator\":\"Unique Pets Seen\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Unique Pets Seen Monthly\",\"category\":\"0\",\"key_performance_indicator\":\"Unique Pets Seen Monthly\",\"displayname\":\"Unique Pets Seen Monthly\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Urinalysis due of above 5 years old Canine\",\"category\":\"0\",\"key_performance_indicator\":\"Urinalysis due of above 5 years old Canine\",\"displayname\":\"Urinalysis_due_5_years_old_Canine\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Urinalysis due of above 5 years old Feline\",\"category\":\"0\",\"key_performance_indicator\":\"Urinalysis due of above 5 years old Feline\",\"displayname\":\"Urinalysis_due_5_years_old_Feline\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Urinalysis due of all above 5 years old Canine\",\"category\":\"0\",\"key_performance_indicator\":\"Urinalysis due of all above 5 years old Canine\",\"displayname\":\"Urinalysis due of all above 5 years old Canine\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Urinalysis due of all above 5 years old Feline\",\"category\":\"0\",\"key_performance_indicator\":\"Urinalysis due of all above 5 years old Feline\",\"displayname\":\"Urinalysis due of all above 5 years old Feline\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Vaccination Standards\",\"category\":\"0\",\"key_performance_indicator\":\"Vaccination Standards\",\"displayname\":\"Vaccination_Standards\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Variable Costs\",\"category\":\"0\",\"key_performance_indicator\":\"Variable Costs\",\"displayname\":\"Variable Costs\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Veterinarian\",\"category\":\"0\",\"key_performance_indicator\":\"Veterinarian\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Veterinarian Adjusted Production\",\"category\":\"0\",\"key_performance_indicator\":\"Veterinarian Adjusted Production\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Veterinary Technician\",\"category\":\"0\",\"key_performance_indicator\":\"Veterinary Technician\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Veterinary Technician Adjusted Production\",\"category\":\"0\",\"key_performance_indicator\":\"Veterinary Technician Adjusted Production\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Whitening by Office Trend\",\"category\":\"0\",\"key_performance_indicator\":\"Whitening by Office Trend\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/Work Days by Practice\",\"category\":\"0\",\"key_performance_indicator\":\"Work Days by Practice\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/YDCollection\",\"category\":\"0\",\"key_performance_indicator\":\"YDCollection\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/ydCollectionPM\",\"category\":\"0\",\"key_performance_indicator\":\"ydCollectionPM\",\"displayname\":\"ydCollectionPM\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/YDNewPatient\",\"category\":\"0\",\"key_performance_indicator\":\"YDNewPatient\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/YDNoShow\",\"category\":\"0\",\"key_performance_indicator\":\"YDNoShow\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/YDPatReAppt\",\"category\":\"0\",\"key_performance_indicator\":\"YDPatReAppt\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/YDProdByProv\",\"category\":\"0\",\"key_performance_indicator\":\"YDProdByProv\",\"displayname\":\"0\",\"type\":\"$\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/ydProductionPM\",\"category\":\"0\",\"key_performance_indicator\":\"ydProductionPM\",\"displayname\":\"ydProductionPM\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/YDProvider\",\"category\":\"0\",\"key_performance_indicator\":\"YDProvider\",\"displayname\":\"0\",\"type\":\"0\"},{\"href\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/kpis\\/YDWalkInPat\",\"category\":\"0\",\"key_performance_indicator\":\"YDWalkInPat\",\"displayname\":\"0\",\"type\":\"0\"}]}]\r\n"}],"_postman_id":"6877cb64-f5ea-423d-845d-5748abb59169"},{"name":"Data of Key Performance Indicators","id":"f0d18b52-24c3-486e-9880-81baffcf505c","request":{"method":"GET","header":[],"url":"{{url}}/kpis/{key_performance_indicator}?request_key={{request_key}}&startdate=2017-05-01&enddate=2017-05-12","description":"

This API will return key performance indicator's data based on date range and practice id passed.

Sample response is attached for 'Accounts Receivable' API.

https://api.sikkasoft.com/v2/kpis/Accounts Receivable?request_key={request_key}&startdate={start date}&enddate={end date}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
key_performance_indicator	key_performance_indicator as per 'kpis' endpoint response	Yes
startdate	key performance indicator data start date.Date format : yyyy-mm-dd	Yes
end	key performance indicator data end date.Date format : yyyy-mm-dd	Yes
practice_id	Practice ID	No

","urlObject":{"path":["kpis","{key_performance_indicator}"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"},{"key":"startdate","value":"2017-05-01"},{"key":"enddate","value":"2017-05-12"}],"variable":[]}},"response":[{"id":"a2ff4407-ef19-4e7d-ba4f-9189bf745ff3","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sikkasoft.com/v2/kpis/Accounts%20Receivable?request_key=request_key&startdate=2017-05-01&enddate=2017-05-12","protocol":"https","host":["api","sikkasoft","com"],"path":["v2","kpis","Accounts%20Receivable"],"query":[{"key":"request_key","value":"request_key"},{"key":"startdate","value":"2017-05-01"},{"key":"enddate","value":"2017-05-12"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private,max-age=86400","description":""},{"name":"Content-Encoding","key":"Content-Encoding","value":"gzip","description":""},{"name":"Content-Length","key":"Content-Length","value":"262","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 12 May 2017 21:38:35 GMT","description":""},{"name":"Expires","key":"Expires","value":"Wed, 01 Jan 1997 12:00:00 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"Vary","key":"Vary","value":"Accept-Encoding","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"offset\":\"0\",\"limit\":\"4\",\"total_count\":\"4\",\"items\":[{\"actual\":\"70544.88\",\"name\":\"Less than 30 days\"},{\"actual\":\"50656.08\",\"name\":\"31 to 60 days\"},{\"actual\":\"13799.35\",\"name\":\"61 to 90 days\"},{\"actual\":\"86742.7\",\"name\":\"More than 90 days\"}]}]\r\n"}],"_postman_id":"f0d18b52-24c3-486e-9880-81baffcf505c"}],"id":"aafd30e1-fcab-425e-89b4-da6d3e8c9128","description":"

A key performance indicator (KPI) is a business metric used to evaluate factors that are crucial to the success of an organization.KPIs give you unique views of practice data that lead to action items to drive increased revenue and save valuable practice time. \nFor more information : https://sikkasoft.zendesk.com/hc/en-us/articles/212443746-Key-Performance-Indicator-KPI-

\n","_postman_id":"aafd30e1-fcab-425e-89b4-da6d3e8c9128"},{"name":"start","id":"f52afb13-0660-46a8-82d8-1c3c87fad3cb","request":{"method":"GET","header":[],"url":"{{url}}/start?app_id={{app_id}}&app_key={{app_key}}&office_id={{office_id}}&secret_key={{secret_key}}","description":"

The \"start\" function is used to initiate the communication between the application and Sikka API. It generates a unique requestkey and starts the request session.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
app_id	This is the ID assigned to the application when the application is registered on API portal	Yes
app_key	This is the unique key generated when the application is registered on API portal	Yes
office_id	Mastercustomerid, This is the ID assigned to a practice when that practice is added	Yes
secret_key	This is the Secrete Key generated for that practice, when practice is added	Yes

","urlObject":{"path":["start"],"host":["{{url}}"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"},{"key":"office_id","value":"{{office_id}}"},{"key":"secret_key","value":"{{secret_key}}"}],"variable":[]}},"response":[{"id":"2465f129-f17a-497c-ab58-a7c949681229","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/start?app_id={{app_id}}&app_key={{app_key}}&office_id={{office_id}}&secret_key={{secret_key}}","host":["{{url}}"],"path":["start"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"},{"key":"office_id","value":"{{office_id}}"},{"key":"secret_key","value":"{{secret_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"private","description":""},{"name":"content-encoding","key":"content-encoding","value":"gzip","description":""},{"name":"content-length","key":"content-length","value":"254","description":""},{"name":"content-type","key":"content-type","value":"application/json","description":""},{"name":"date","key":"date","value":"Wed, 27 Sep 2017 11:51:51 GMT","description":""},{"name":"server","key":"server","value":"Microsoft-IIS/8.5","description":""},{"name":"vary","key":"vary","value":"Accept-Encoding","description":""},{"name":"x-aspnet-version","key":"x-aspnet-version","value":"4.0.30319","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"scope\": \"https://api.sikkasoft.com/v2/\",\n \"request_key\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"token_type\": \"Bearer\",\n \"expires_in\": \"86400\"\n }\n]"},{"id":"768a8a34-08c1-4130-a51f-68158d4eca42","name":"start","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/start?app_id={{app_id}}&app_key={{app_key}}&office_id={{office_id}}&secret_key={{secret_key}}","host":["{{url}}"],"path":["start"],"query":[{"key":"app_id","value":"{{app_id}}"},{"key":"app_key","value":"{{app_key}}"},{"key":"office_id","value":"{{office_id}}"},{"key":"secret_key","value":"{{secret_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"141","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 06:48:56 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[{\"scope\":\"https:\\/\\/api.sikkasoft.com\\/v2\\/\",\"request_key\":\"ad9beb2883ed1a2277d1aac15fc9793d\",\"token_type\":\"Bearer\",\"expires_in\":\"86400\"}]\r\n"}],"_postman_id":"f52afb13-0660-46a8-82d8-1c3c87fad3cb"},{"name":"end","id":"2cb78965-b345-4737-8f30-097b01720e4e","request":{"method":"GET","header":[],"url":"{{url}}/end?request_key={{request_key}}","description":"

The \"end\" function is used to terminate the request session.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes

","urlObject":{"path":["end"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"0202e62c-742a-45eb-952c-43b157810256","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/end?request_key={{request_key}}","host":["{{url}}"],"path":["end"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"174","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 09:21:28 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"{\"http_code\":\"200\",\"http_code_desc\":\"OK\",\"sikka_status_code\":\"API0003\",\"short_message\":\"OK\",\"long_message\":\"Request Session terminated successfully.\",\"more_information\":\"\"}\r\n"}],"_postman_id":"2cb78965-b345-4737-8f30-097b01720e4e"},{"name":"data_check","id":"975d37a8-541c-4cbd-875d-bd32d09938cd","request":{"method":"GET","header":[],"url":"{{url}}/data_check?request_key={{request_key}}","description":"

The \"end\" function is used to terminate the request session.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes

","urlObject":{"path":["data_check"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"}],"variable":[]}},"response":[{"id":"de9db9d1-ff98-40a2-9a96-547fb69f88df","name":"request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/end?request_key={{request_key}}","host":["{{url}}"],"path":["end"],"query":[{"key":"request_key","value":"{{request_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"accept, authorization, Content-Type, X-Session-Id","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private, no-cache=\"set-cookie\"","description":""},{"name":"Connection","key":"Connection","value":"keep-alive","description":""},{"name":"Content-Length","key":"Content-Length","value":"174","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Fri, 21 Apr 2017 09:21:28 GMT","description":""},{"name":"Server","key":"Server","value":"Microsoft-IIS/8.5","description":""},{"name":"X-AspNet-Version","key":"X-AspNet-Version","value":"4.0.30319","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"ASP.NET","description":""}],"cookie":[],"responseTime":null,"body":"[\r\n\t{\r\n\t\t\"offset\": \"0\",\r\n\t\t\"limit\": \"500\",\r\n\t\t\"total_count\": \"5\",\r\n\t\t\"execution_time\": \"715\",\r\n\t\t\"items\": [\r\n\t\t\t{\r\n\t\t\t\t\"api\": \"accounts_receivables\",\r\n\t\t\t\t\"total_records\": \"11212\",\r\n\t\t\t\t\"update_time\": \"2017-11-10 11:07:29\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"api\": \"appointments\",\r\n\t\t\t\t\"total_records\": \"43547\",\r\n\t\t\t\t\"update_time\": \"2017-11-10 12:02:53\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"api\": \"claim_descriptions\",\r\n\t\t\t\t\"total_records\": \"32326\",\r\n\t\t\t\t\"update_time\": \"2017-11-10 11:03:46\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"api\": \"claims\",\r\n\t\t\t\t\"total_records\": \"32000\",\r\n\t\t\t\t\"update_time\": \"2017-11-10 11:03:35\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"api\": \"clinical_conditions\",\r\n\t\t\t\t\"total_records\": \"34\",\r\n\t\t\t\t\"update_time\": \"2017-11-10 11:07:56\"\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n]"}],"_postman_id":"975d37a8-541c-4cbd-875d-bd32d09938cd"},{"name":"practice_events","id":"a0a0d2a9-39dd-42be-94d0-a31d3f0926e8","request":{"method":"GET","header":[],"url":"{{url}}/practice_events?request_key={{request_key}}&loaded_startdate=2018-01-01&loaded_enddate=2018-01-07&events=patients,appointments,transactions&interval=15","description":"

\nThis api will return what data has been changed in practice between given date range. \nIn response you will get data with flags Deleted , Added & Updated

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required?
request_key	Valid 32 characters alpha-numeric request key	Yes
loaded_startdate	Start date for getting only changed record set. Date format : yyyy-mm-dd or yyyy-MM-ddTHH:mm:ss	yes
loaded_enddate	End date for getting only changed record set. Date format : yyyy-mm-dd or yyyy-MM-ddTHH:mm:ss	yes
events	Name of the events you want to get modified records. Events name must match with API name	yes
interval	Value must be integer. 'interval' parameter allows user to fetch records , which has been changed in last minutes. This will be helpful when user does not know loaded_startdate/loaded_enddate and just want to fetch records which has been changed in last minutes (let say 5,10,15.. etc minutes). Maximun value for interval is 1440. You can fetch data which has been changed in last 24 hours (1440 minutes, interval=1440) without specifying loaded_startdate and loaded_enddate. Note : Make sure Sikka platform utility is up and running on client machine. To check when Sikka platform utility (SPU) has refreshed, call 'authorized_practices' and get 'data_insert_date'.	yes

API to find change logs of records :

To find patient’s modified records : \nhttps://api.sikkasoft.com/v2/patients?request_key={ }&loaded_startdate={}&loaded_enddate={ }

To find appointments modified records : \nhttps://api.sikkasoft.com/v2/appointments?request_key={ }&loaded_startdate={}&loaded_enddate={ }

To find transaction’s modified records : \nhttps://api.sikkasoft.com/v2/transactions?request_key={ }&loaded_startdate={}&loaded_enddate={ }

In practice_events API

https://api.sikkasoft.com/v2/practice_events?request_key={ }&loaded_startdate={}&loaded_enddate={ }&events={name of data you want to retrieve }

For example , if you want to retrive patients , appointments and transactions modified records

https://api.sikkasoft.com/v2/practice_events?request_key={ }&loaded_startdate={}&loaded_enddate={ }&events=patients/appointments/transactions

Response :

[\n  {\n    \"accounts_receivables\": [],\n    \"appointments\": [],\n    \"guarantors\": [],\n    \"guarantors_v2\": [],\n    \"patients\": [],\n    \"practices\": [],\n    \"providers\": [],\n    \"transactions\": [],\n    \"treatment_plans\": []\n  }\n]\n

When to use practice_events API ?

If you want to get list of modified record using one API\nDon't want to process raw data on your side and just get updated records

Recommandation

Use it for short date range like week or less.
It will work for longer date range but response will be slow and data accuracy will be affected
Use either interval and flag or loaded_startdate, loaded_enddate and flag comobination
If interval parameter is passed then loaded_startdate and loaded_enddate parameters will not be captured

\n##### Limitation : \n\n

Currently you will be able to get events from \n a ) Patients \n b ) Appointments\n c ) Transactions \n d ) Accounts Receivables\n e ) Guarantors\n f ) Guarantors_v2\n g ) Practices\n h ) Providers\n i ) Treatment Plans\nWe will update the list of events as we add in API

\n","urlObject":{"path":["practice_events"],"host":["{{url}}"],"query":[{"key":"request_key","value":"{{request_key}}"},{"key":"loaded_startdate","value":"2018-01-01"},{"key":"loaded_enddate","value":"2018-01-07"},{"key":"events","value":"patients,appointments,transactions"},{"key":"interval","value":"15"}],"variable":[]}},"response":[{"id":"36112630-fab5-4549-ba31-72ccae519050","name":"practice_events","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/practice_events?request_key={{request_key}}&loaded_startdate=2018-01-01&loaded_enddate=2018-01-07&events=patients,appointments,transactions","host":["{{url}}"],"path":["practice_events"],"query":[{"key":"request_key","value":"{{request_key}}"},{"key":"loaded_startdate","value":"2018-01-01"},{"key":"loaded_enddate","value":"2018-01-07"},{"key":"events","value":"patients,appointments,transactions"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"\\\\ In API request you asked for return the modified records for appointments , patients and transactions. \r\n\\\\ In response below API will return modifed data with loaded_data and flag( added , deleted or updated ) \r\n[\r\n{\r\n\"appointments\": [\r\n{\r\n\"offset\": \"0\",\r\n\"limit\": \"1\",\r\n\"total_count\": \"1\",\r\n\"execution_time\": \"71\",\r\n\"items\": [\r\n{\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/practice_events/20049290930177001\",\r\n\"appointment_sr_no\": \"20049290930177001\",\r\n\"patient_id\": \"77001\",\r\n\"patient\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/77001\"\r\n},\r\n\"operatory\": \"2\",\r\n\"date\": \"2004-09-29\",\r\n\"time\": \"09:30\",\r\n\"length\": \"30\",\r\n\"description\": \"\",\r\n\"amount\": \"40.0000\",\r\n\"status\": \"Fixed\",\r\n\"last_changed_date\": \"2004-09-29\",\r\n\"appointment_made_date\": \"2004-09-29\",\r\n\"type\": \"General\",\r\n\"procedure_code1\": \"120\",\r\n\"procedure_code1_amount\": \"40\",\r\n\"procedure_code2\": \"0\",\r\n\"procedure_code2_amount\": \"0\",\r\n\"procedure_code3\": \"0\",\r\n\"procedure_code3_amount\": \"0\",\r\n\"procedure_code4\": \"0\",\r\n\"procedure_code4_amount\": \"0\",\r\n\"procedure_code5\": \"0\",\r\n\"procedure_code5_amount\": \"0\",\r\n\"procedure_code6\": \"0\",\r\n\"procedure_code6_amount\": \"0\",\r\n\"procedure_code7\": \"0\",\r\n\"procedure_code7_amount\": \"0\",\r\n\"hygienist\": \"18\",\r\n\"provider_id\": \"1\",\r\n\"provider\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/1\"\r\n},\r\n\"practice_id\": \"1\",\r\n\"practice\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1\"\r\n},\r\n\"is_companion\": \"\",\r\n\"sooner_if_possible\": \"\",\r\n\"confirmed_on_date\": \"2004-09-29\",\r\n\"note\": \"\",\r\n\"loadeddate\": \"2018-02-21 18:04:00\",\r\n\"flag\": \"deleted\",\r\n\"patient_name\": \"Gosonon Lis\",\r\n\"guarantor_id\": \"\",\r\n\"guarantor_name\": \"\",\r\n\"procedure_code1_time\": \"30\",\r\n\"procedure_code2_time\": \"0\",\r\n\"procedure_code3_time\": \"0\",\r\n\"procedure_code4_time\": \"0\",\r\n\"procedure_code5_time\": \"0\",\r\n\"procedure_code6_time\": \"0\",\r\n\"procedure_code7_time\": \"0\",\r\n\"tooth_number\": \"10\",\r\n\"surface_quadrant\": \"\",\r\n\"surface_quadrant_type\": \"\",\r\n\"schedule\": \"Fixed\",\r\n\"treatment_class\": \"\"\r\n}\r\n]\r\n}\r\n],\r\n\"patients\": [\r\n{\r\n\"offset\": \"0\",\r\n\"limit\": \"1\",\r\n\"total_count\": \"1\",\r\n\"execution_time\": \"71\",\r\n\"items\": [\r\n{\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/practice_events/507704\",\r\n\"patient_id\": \"507704\",\r\n\"guarantor_id\": \"507700\",\r\n\"firstname\": \"patient F\",\r\n\"middlename\": \"\",\r\n\"lastname\": \"Patient L\",\r\n\"preferred_name\": \"Stephen\",\r\n\"salutation\": \"\",\r\n\"birthdate\": \"1969-12-01\",\r\n\"status\": \"Inactive\",\r\n\"patient_note\": \"\",\r\n\"medical_note\": \"\",\r\n\"alert_note\": \"\",\r\n\"other_note\": \"\",\r\n\"gender\": \"Male\",\r\n\"address_line1\": \"Address1\",\r\n\"address_line2\": \"\",\r\n\"city\": \"Los Banos\",\r\n\"state\": \"CA\",\r\n\"zipcode\": \"93635\",\r\n\"homephone\": \"\",\r\n\"workphone\": \"\",\r\n\"cell\": \"(111)-111-1111\",\r\n\"email\": \"patient@email.com\",\r\n\"employer_id\": \"294\",\r\n\"employer\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/employers/294\"\r\n},\r\n\"billing_type\": \"Non insurance patient\",\r\n\"first_visit\": \"2012-08-16\",\r\n\"last_visit\": \"2013-07-05\",\r\n\"provider_id\": \"1\",\r\n\"provider\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/1\"\r\n},\r\n\"practice_id\": \"1\",\r\n\"practice\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1\"\r\n},\r\n\"appointments\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/appointments?patient_id=507704\"\r\n},\r\n\"guarantor\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/507700\"\r\n},\r\n\"primary_insurance_company_id\": \"2645\",\r\n\"primary_insurance_company\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies/2645\"\r\n},\r\n\"secondary_insurance_company_id\": \"\",\r\n\"secondary_insurance_company\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/insurance_companies\"\r\n},\r\n\"primary_relationship\": \"Self\",\r\n\"country\": \"\",\r\n\"secondary_relationship\": \"\",\r\n\"loadeddate\": \"2018-02-20 18:04:00\",\r\n\"flag\": \"added\",\r\n\"patient_account_id\": \"\",\r\n\"other_referral\": \"\",\r\n\"patient_referral\": \"referred_by_patient\",\r\n\"referred_out\": \"\",\r\n\"referred_by_provider_id\": \"\",\r\n\"referred_by_patient_id\": \"507703\",\r\n\"fee_no\": \"3\",\r\n\"guarantor_first_name\": \"patient f\",\r\n\"guarantor_last_name\": \"patient l\",\r\n\"created_date\": \"2012-08-01\",\r\n\"patient_codes\": \"I\"\r\n}\r\n]\r\n}\r\n],\r\n\"transactions\": [\r\n{\r\n\"offset\": \"0\",\r\n\"limit\": \"1\",\r\n\"total_count\": \"1\",\r\n\"execution_time\": \"71\",\r\n\"items\": [\r\n{\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/practice_events/517292\",\r\n\"transaction_sr_no\": \"517292\",\r\n\"patient_id\": \"694101\",\r\n\"patient\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/patients/694101\"\r\n},\r\n\"guarantor_id\": \"694100\",\r\n\"guarantor\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/guarantors/694100\"\r\n},\r\n\"transaction_type\": \"Procedure\",\r\n\"transaction_date\": \"2018-02-20\",\r\n\"transaction_entry_date\": \"2018-02-20\",\r\n\"procedure_code\": \"230\",\r\n\"procedure_description\": \"Intraoral - Periapical-Each Add'l Rad Img\",\r\n\"provider_id\": \"1\",\r\n\"provider\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/providers/1\"\r\n},\r\n\"amount\": \"33.0000\",\r\n\"tooth_from\": \"0\",\r\n\"tooth_to\": \"0\",\r\n\"estimated_insurance_payment\": \"33\",\r\n\"practice_id\": \"1\",\r\n\"practice\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1\"\r\n},\r\n\"loadeddate\": \"2018-02-21 18:03:00\",\r\n\"flag\": \"added\",\r\n\"invoice_number\": \"\",\r\n\"invoice_status\": \"\",\r\n\"invoice_item\": \"\",\r\n\"quantity\": \"\",\r\n\"claim_sr_no\": \"57009\",\r\n\"claim\": {\r\n\"href\": \"https://api.sikkasoft.com/v2/practices/1/claims/57009\"\r\n},\r\n\"pre_authorization_id\": \"\",\r\n\"payment_type\": \"\",\r\n\"surface\": \"\",\r\n\"note\": \"\",\r\n\"is_group_transaction\": \"0\",\r\n\"cheque_no\": \"\",\r\n\"clinical_condition_id\": \"\",\r\n\"collection_provider_id\": \"1\",\r\n\"created_by\": \"\",\r\n\"last_updated_by\": \"\",\r\n\"primary_insurance_estimate\": \"33.0000\",\r\n\"secondary_insurance_estimate\": \"0.0000\",\r\n\"surface_quadrant_type\": \"\"\r\n}\r\n]\r\n}\r\n]\r\n}\r\n]"}],"_postman_id":"a0a0d2a9-39dd-42be-94d0-a31d3f0926e8"}]}