Care Cloud Finance API’s

mark.thompson@oneadvanced.com Updated by mark.thompson@oneadvanced.com

This article describes the Postman collection to interact with Care Cloud Finance API's

Authorization OAuth 2.0

GET Health Check

https:// [INTEGRATION_URL]/api/health-check

Check if API is available

GET Pending Finance Extracts

https://[INTEGRATION_URL]/api/core/data/careproviderfinanceextractbatch/system-view/notdownloaded

Download finance extract files with status of not-downloaded

GET Get Signed URL 

https:// [INTEGRATION_URL]/api/files/download-url/careproviderfinanceextractbatch/046898fb-5c8b-ed11-83d6-026f7575350a

Get file id from first request to get the file download url

"extractcontent": {

"id": "046898fb-5c8b-ed11-83d6-026f7575350a" }

GET Download File

Download file based on URL from Get Signed URL step

Body file

PUT Set Extract as Downloaded

https:// [INTEGRATION_URL]/api/core/data/careproviderfinanceextractbatch/838b4df3-5b8b-ed11-83d6-026f7575350a

Use id from first request to mark the extract as downloaded.

Body raw (json)

json

{

    "isdownloaded":"true"

}

Sequence Diagram

Following diagram illustrate sequence of events that should happen to work with this API.

Postman Collection

CareCloud-Financials.postman_collection.json

Open API Definition

CareCloudFinancials | 1.0.0 | AdvancedComputerSoft | SwaggerHub

Was this article useful?

Glossary

FAQ - Why can't we see all Residents in the Mobile App?

Contact