COcollectly
statements

Get current patient statement

Changed on

This endpoint is an alternative data model where you do not need to push payments and allocations separately. You just POST a complete list of outstanding visits/charges and this statement will be presented to the patient as POSTed. /visit endpoint is ignored if you POSTed the statement for the patient /payments that have the post_date before the statement are also ignored

get/practices/{practice_id}/patients/{patient_id}/statement

Request

  • Base URL
    sandbox.collectly.co/api/api/partners/v1 (relative, and the document’s source URL is not known)
  • URL
    sandbox.collectly.co/api/api/partners/v1/practices/{practice_id}/patients/{patient_id}/statement
  • Auth
    API key in header Authorization

Path parameters

practice_idstring required

Practice ID in which the requested resource exists

patient_idstring required

Patient ID from your integration who owns the resource

Query parameters

pageinteger

Page number of dataset

per_pageinteger

Custom page size of dataset

sortstring

String with a comma-separated list of parameters by which to sort the dataset. To specify a descending order, add a "-" character before the parameter. For example, ?sort=-created_at,id

Response

OK

allowed_amountnumber nullable
billed_amountnumber nullable
created_atunknown
idinteger
ins_paidnumber nullable
modified_atunknown
patient_idstring
practice_idstring required
pt_amountnumber
pt_balancenumber

Changes