Apply a deposit to an invoice
curl --request POST \
--url https://api.eka.care/ipd/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/allocate \
--header 'Content-Type: application/json' \
--header 'auth: <auth>' \
--data '
{
"amount": "<string>",
"invoiceId": "<string>"
}
'import requests
url = "https://api.eka.care/ipd/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/allocate"
payload = {
"amount": "<string>",
"invoiceId": "<string>"
}
headers = {
"auth": "<auth>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {auth: '<auth>', 'Content-Type': 'application/json'},
body: JSON.stringify({amount: '<string>', invoiceId: '<string>'})
};
fetch('https://api.eka.care/ipd/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/allocate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.eka.care/ipd/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/allocate")
.header("auth", "<auth>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"<string>\",\n \"invoiceId\": \"<string>\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.eka.care/ipd/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/allocate");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("auth", "<auth>");
request.AddJsonBody("{\n \"amount\": \"<string>\",\n \"invoiceId\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
require 'uri'
require 'net/http'
url = URI("https://api.eka.care/ipd/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/allocate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["auth"] = '<auth>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"<string>\",\n \"invoiceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "dep-401",
"depositNumber": "DEP-000401",
"amount": "10000.00",
"utilizedAmount": "5000.00",
"refundedAmount": "0.00",
"available": "5000.00",
"status": "active",
"allocations": []
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Deposits
Apply a deposit to an invoice
Applies part of a held deposit against an invoice.
The admission must be on new billing (use_new_billing); otherwise this returns 409. Returns 503 when billing is not configured on the server, and 502 when the billing service fails.
POST
/
ipd
/
sdk
/
admissions
/
{admission_id}
/
billing
/
deposits
/
{deposit_id}
/
allocate
Apply a deposit to an invoice
curl --request POST \
--url https://api.eka.care/ipd/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/allocate \
--header 'Content-Type: application/json' \
--header 'auth: <auth>' \
--data '
{
"amount": "<string>",
"invoiceId": "<string>"
}
'import requests
url = "https://api.eka.care/ipd/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/allocate"
payload = {
"amount": "<string>",
"invoiceId": "<string>"
}
headers = {
"auth": "<auth>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {auth: '<auth>', 'Content-Type': 'application/json'},
body: JSON.stringify({amount: '<string>', invoiceId: '<string>'})
};
fetch('https://api.eka.care/ipd/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/allocate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.eka.care/ipd/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/allocate")
.header("auth", "<auth>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"<string>\",\n \"invoiceId\": \"<string>\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.eka.care/ipd/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/allocate");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("auth", "<auth>");
request.AddJsonBody("{\n \"amount\": \"<string>\",\n \"invoiceId\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
require 'uri'
require 'net/http'
url = URI("https://api.eka.care/ipd/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/allocate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["auth"] = '<auth>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"<string>\",\n \"invoiceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "dep-401",
"depositNumber": "DEP-000401",
"amount": "10000.00",
"utilizedAmount": "5000.00",
"refundedAmount": "0.00",
"available": "5000.00",
"status": "active",
"allocations": []
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Headers
Path Parameters
Id of the IPD admission.
Minimum string length:
1Id of the deposit.
Minimum string length:
1Body
application/json
Response
An advance / deposit: id, depositNumber, amount, utilizedAmount, refundedAmount, available, status, allocations, …
An advance / deposit: id, depositNumber, amount, utilizedAmount, refundedAmount, available, status, allocations, …
Was this page helpful?

