Patient Liabilities
Create Patient Liability
Record a payment the practice already collected outside Elation. Creates a paid liability with its completed payment; no patient receipt is sent.
POST
/
api
/
2.0
/
patient_liabilities
/
Create Patient Liability
curl --request POST \
--url https://sandbox.elationemr.com/api/2.0/patient_liabilities/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"invoice_number": "<string>",
"patient_id": 123,
"payment": {
"amount_usd": "<string>",
"paid_at": "2023-11-07T05:31:56Z",
"reference_number": "<string>"
},
"practice_id": 123,
"reasons": [],
"total_amount_usd": "<string>",
"external_memo": "<string>",
"internal_memo": "<string>"
}
'import requests
url = "https://sandbox.elationemr.com/api/2.0/patient_liabilities/"
payload = {
"invoice_number": "<string>",
"patient_id": 123,
"payment": {
"amount_usd": "<string>",
"paid_at": "2023-11-07T05:31:56Z",
"reference_number": "<string>"
},
"practice_id": 123,
"reasons": [],
"total_amount_usd": "<string>",
"external_memo": "<string>",
"internal_memo": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
invoice_number: '<string>',
patient_id: 123,
payment: {
amount_usd: '<string>',
paid_at: '2023-11-07T05:31:56Z',
reference_number: '<string>'
},
practice_id: 123,
reasons: [],
total_amount_usd: '<string>',
external_memo: '<string>',
internal_memo: '<string>'
})
};
fetch('https://sandbox.elationemr.com/api/2.0/patient_liabilities/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.elationemr.com/api/2.0/patient_liabilities/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'invoice_number' => '<string>',
'patient_id' => 123,
'payment' => [
'amount_usd' => '<string>',
'paid_at' => '2023-11-07T05:31:56Z',
'reference_number' => '<string>'
],
'practice_id' => 123,
'reasons' => [
],
'total_amount_usd' => '<string>',
'external_memo' => '<string>',
'internal_memo' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.elationemr.com/api/2.0/patient_liabilities/"
payload := strings.NewReader("{\n \"invoice_number\": \"<string>\",\n \"patient_id\": 123,\n \"payment\": {\n \"amount_usd\": \"<string>\",\n \"paid_at\": \"2023-11-07T05:31:56Z\",\n \"reference_number\": \"<string>\"\n },\n \"practice_id\": 123,\n \"reasons\": [],\n \"total_amount_usd\": \"<string>\",\n \"external_memo\": \"<string>\",\n \"internal_memo\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.elationemr.com/api/2.0/patient_liabilities/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"invoice_number\": \"<string>\",\n \"patient_id\": 123,\n \"payment\": {\n \"amount_usd\": \"<string>\",\n \"paid_at\": \"2023-11-07T05:31:56Z\",\n \"reference_number\": \"<string>\"\n },\n \"practice_id\": 123,\n \"reasons\": [],\n \"total_amount_usd\": \"<string>\",\n \"external_memo\": \"<string>\",\n \"internal_memo\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elationemr.com/api/2.0/patient_liabilities/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invoice_number\": \"<string>\",\n \"patient_id\": 123,\n \"payment\": {\n \"amount_usd\": \"<string>\",\n \"paid_at\": \"2023-11-07T05:31:56Z\",\n \"reference_number\": \"<string>\"\n },\n \"practice_id\": 123,\n \"reasons\": [],\n \"total_amount_usd\": \"<string>\",\n \"external_memo\": \"<string>\",\n \"internal_memo\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"reasons": [
"<string>"
],
"total_amount_usd": "<string>",
"date_of_service": "2023-11-07T05:31:56Z",
"external_memo": "<string>",
"internal_memo": "<string>",
"invoice_number": "<string>",
"legal_entity_id": -1,
"paid_at": "2023-11-07T05:31:56Z",
"patient_id": 123,
"payment_charges": [
{
"amount_usd": "<string>",
"amount_refunded_usd": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"id": 123,
"last_status_change_at": "2023-11-07T05:31:56Z",
"payment_method_description": "<string>",
"reference_number": "<string>",
"refunded_at": "2023-11-07T05:31:56Z"
}
],
"payment_requests": [
{
"amount_usd": "<string>",
"status": "Attempting to collect payment",
"collected_at": "2023-11-07T05:31:56Z",
"id": 123,
"last_reminder_sent_at": "2023-11-07T05:31:56Z",
"last_status_change_at": "2023-11-07T05:31:56Z"
}
],
"practice_id": 123,
"practice_stripe_account_id": 123,
"voided_at": "2023-11-07T05:31:56Z"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
Maximum string length:
50Show child attributes
Show child attributes
Elation Billing practices accept exactly one reason: copay or outstanding_balance.
coinsurance- coinsurancecopay- copaydeductible- deductibledirect_payment- direct_paymentinjection_shot- injection_shotlab_imaging- lab_imagingmedications- medicationsmembership_fee- membership_feeother- otheroutstanding_balance- outstanding_balancepayment_installment- payment_installmentsupplements- supplements
Available options:
coinsurance, copay, deductible, direct_payment, injection_shot, lab_imaging, medications, membership_fee, other, outstanding_balance, payment_installment, supplements Pattern:
^-?\d{0,6}(?:\.\d{0,2})?$Maximum string length:
2000Maximum string length:
500Response
Pattern:
^-?\d{0,6}(?:\.\d{0,2})?$Maximum string length:
2000Maximum string length:
500Maximum string length:
50Required range:
-2147483648 <= x <= 2147483647Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Create Patient Liability
curl --request POST \
--url https://sandbox.elationemr.com/api/2.0/patient_liabilities/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"invoice_number": "<string>",
"patient_id": 123,
"payment": {
"amount_usd": "<string>",
"paid_at": "2023-11-07T05:31:56Z",
"reference_number": "<string>"
},
"practice_id": 123,
"reasons": [],
"total_amount_usd": "<string>",
"external_memo": "<string>",
"internal_memo": "<string>"
}
'import requests
url = "https://sandbox.elationemr.com/api/2.0/patient_liabilities/"
payload = {
"invoice_number": "<string>",
"patient_id": 123,
"payment": {
"amount_usd": "<string>",
"paid_at": "2023-11-07T05:31:56Z",
"reference_number": "<string>"
},
"practice_id": 123,
"reasons": [],
"total_amount_usd": "<string>",
"external_memo": "<string>",
"internal_memo": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
invoice_number: '<string>',
patient_id: 123,
payment: {
amount_usd: '<string>',
paid_at: '2023-11-07T05:31:56Z',
reference_number: '<string>'
},
practice_id: 123,
reasons: [],
total_amount_usd: '<string>',
external_memo: '<string>',
internal_memo: '<string>'
})
};
fetch('https://sandbox.elationemr.com/api/2.0/patient_liabilities/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.elationemr.com/api/2.0/patient_liabilities/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'invoice_number' => '<string>',
'patient_id' => 123,
'payment' => [
'amount_usd' => '<string>',
'paid_at' => '2023-11-07T05:31:56Z',
'reference_number' => '<string>'
],
'practice_id' => 123,
'reasons' => [
],
'total_amount_usd' => '<string>',
'external_memo' => '<string>',
'internal_memo' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.elationemr.com/api/2.0/patient_liabilities/"
payload := strings.NewReader("{\n \"invoice_number\": \"<string>\",\n \"patient_id\": 123,\n \"payment\": {\n \"amount_usd\": \"<string>\",\n \"paid_at\": \"2023-11-07T05:31:56Z\",\n \"reference_number\": \"<string>\"\n },\n \"practice_id\": 123,\n \"reasons\": [],\n \"total_amount_usd\": \"<string>\",\n \"external_memo\": \"<string>\",\n \"internal_memo\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.elationemr.com/api/2.0/patient_liabilities/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"invoice_number\": \"<string>\",\n \"patient_id\": 123,\n \"payment\": {\n \"amount_usd\": \"<string>\",\n \"paid_at\": \"2023-11-07T05:31:56Z\",\n \"reference_number\": \"<string>\"\n },\n \"practice_id\": 123,\n \"reasons\": [],\n \"total_amount_usd\": \"<string>\",\n \"external_memo\": \"<string>\",\n \"internal_memo\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elationemr.com/api/2.0/patient_liabilities/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invoice_number\": \"<string>\",\n \"patient_id\": 123,\n \"payment\": {\n \"amount_usd\": \"<string>\",\n \"paid_at\": \"2023-11-07T05:31:56Z\",\n \"reference_number\": \"<string>\"\n },\n \"practice_id\": 123,\n \"reasons\": [],\n \"total_amount_usd\": \"<string>\",\n \"external_memo\": \"<string>\",\n \"internal_memo\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"reasons": [
"<string>"
],
"total_amount_usd": "<string>",
"date_of_service": "2023-11-07T05:31:56Z",
"external_memo": "<string>",
"internal_memo": "<string>",
"invoice_number": "<string>",
"legal_entity_id": -1,
"paid_at": "2023-11-07T05:31:56Z",
"patient_id": 123,
"payment_charges": [
{
"amount_usd": "<string>",
"amount_refunded_usd": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"id": 123,
"last_status_change_at": "2023-11-07T05:31:56Z",
"payment_method_description": "<string>",
"reference_number": "<string>",
"refunded_at": "2023-11-07T05:31:56Z"
}
],
"payment_requests": [
{
"amount_usd": "<string>",
"status": "Attempting to collect payment",
"collected_at": "2023-11-07T05:31:56Z",
"id": 123,
"last_reminder_sent_at": "2023-11-07T05:31:56Z",
"last_status_change_at": "2023-11-07T05:31:56Z"
}
],
"practice_id": 123,
"practice_stripe_account_id": 123,
"voided_at": "2023-11-07T05:31:56Z"
}