View payments
GET {{baseUrl}}/payments?subdomain={{subdomain}}&location_id={{location_id}}&patient_id=<integer>&provider_id=<integer>&procedure_id=<integer>&include[]=<string>&include[]=<string>&page=1&per_page=5
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
location_id | string | (Required) Used to scope the request to the specified location | |
patient_id | string | Filter by patient | |
provider_id | string | Filter by provider | |
procedure_id | string | Filter by procedure | |
include[] | string | Resources to be included in the response | |
include[] | string | Resources to be included in the response | |
page | number | Page number. Starts with page 1 | |
per_page | number | Number of results to return per page. Defaults is 5 per page and Max 300 per page |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":[{"id":"\u003cinteger\u003e","accountable_type":"\u003cstring\u003e","accountable_id":"\u003cinteger\u003e","value":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","procedure_id":"\u003cinteger\u003e","date":"\u003cstring\u003e","patient":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","guarantor_id":"\u003cinteger\u003e","unsubscribe_sms":"\u003cboolean\u003e"},"provider":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","display_name":"\u003cstring\u003e","npi":"\u003cstring\u003e","locations":[{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"institution_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address_2":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"city":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"zip_code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tz":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"last_sync_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"insert_appt_client":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"map_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"set_availability_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inactive":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"institution_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address_2":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"city":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"zip_code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tz":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"last_sync_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"insert_appt_client":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"map_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"set_availability_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inactive":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"provider_requestables":[{"location_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"location_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]},"procedure":{"id":"\u003cinteger\u003e","patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","appointment_id":"\u003cinteger\u003e","code":"\u003cstring\u003e","name":"\u003cstring\u003e","status":"\u003cstring\u003e","body_site":"\u003cobject\u003e","fee":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"start_date":"\u003cdate\u003e","end_date":"\u003cdate\u003e"},"directionality":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","accountable_type":"\u003cstring\u003e","accountable_id":"\u003cinteger\u003e","value":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","procedure_id":"\u003cinteger\u003e","date":"\u003cstring\u003e","patient":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","guarantor_id":"\u003cinteger\u003e","unsubscribe_sms":"\u003cboolean\u003e"},"provider":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","display_name":"\u003cstring\u003e","npi":"\u003cstring\u003e","locations":[{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"institution_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address_2":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"city":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"zip_code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tz":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"last_sync_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"insert_appt_client":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"map_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"set_availability_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inactive":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"institution_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address_2":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"city":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"zip_code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tz":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"last_sync_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"insert_appt_client":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"map_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"set_availability_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inactive":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"provider_requestables":[{"location_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"location_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]},"procedure":{"id":"\u003cinteger\u003e","patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","appointment_id":"\u003cinteger\u003e","code":"\u003cstring\u003e","name":"\u003cstring\u003e","status":"\u003cstring\u003e","body_site":"\u003cobject\u003e","fee":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"start_date":"\u003cdate\u003e","end_date":"\u003cdate\u003e"},"directionality":"\u003cstring\u003e"}],"count":"\u003cinteger\u003e"}