Update Saved Item
curl --request PUT \
--url https://api.decodahealth.com/billing/discounts/saved-item/{discount_id} \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"quantity": 123,
"quantityRemaining": 1,
"comment": "<string>"
}
'import requests
url = "https://api.decodahealth.com/billing/discounts/saved-item/{discount_id}"
payload = {
"quantity": 123,
"quantityRemaining": 1,
"comment": "<string>"
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({quantity: 123, quantityRemaining: 1, comment: '<string>'})
};
fetch('https://api.decodahealth.com/billing/discounts/saved-item/{discount_id}', 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://api.decodahealth.com/billing/discounts/saved-item/{discount_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'quantity' => 123,
'quantityRemaining' => 1,
'comment' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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://api.decodahealth.com/billing/discounts/saved-item/{discount_id}"
payload := strings.NewReader("{\n \"quantity\": 123,\n \"quantityRemaining\": 1,\n \"comment\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
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.put("https://api.decodahealth.com/billing/discounts/saved-item/{discount_id}")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"quantity\": 123,\n \"quantityRemaining\": 1,\n \"comment\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/billing/discounts/saved-item/{discount_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quantity\": 123,\n \"quantityRemaining\": 1,\n \"comment\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"itemId": "<string>",
"patientId": "<string>",
"quantity": 123,
"quantityRemaining": 123,
"createdDate": "2023-11-07T05:31:56Z",
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"sortOrder": 123,
"allowCustomPricing": false,
"showInCheckOut": true,
"type": "PRODUCT",
"externalId": "<string>",
"exemptedTaxIds": [
"<string>"
],
"cost": 123,
"cashPrice": 123,
"commissionable": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>"
}
],
"hiddenInPatientPortal": false,
"hiddenInOnlineShop": true,
"loyaltyPointsEarned": 1,
"defaultCptCode": "<string>",
"defaultModifiers": [
"<string>"
],
"defaultIcd10Codes": [
"<string>"
],
"defaultPlaceOfService": "<string>"
},
"price": 123,
"createdByChargeItemId": "<string>",
"comment": "<string>",
"usages": [
{
"chargeId": "<string>",
"chargeItemId": "<string>",
"chargeDate": "2023-11-07T05:31:56Z",
"quantityUsed": 123,
"chargeTotal": 123,
"kind": "charge"
}
],
"originatingCharge": {
"id": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"description": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Discounts
Update Saved Item
Update a saved item (SAVED_ITEM discount). Replaces legacy update banked item.
PUT
/
billing
/
discounts
/
saved-item
/
{discount_id}
Update Saved Item
curl --request PUT \
--url https://api.decodahealth.com/billing/discounts/saved-item/{discount_id} \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"quantity": 123,
"quantityRemaining": 1,
"comment": "<string>"
}
'import requests
url = "https://api.decodahealth.com/billing/discounts/saved-item/{discount_id}"
payload = {
"quantity": 123,
"quantityRemaining": 1,
"comment": "<string>"
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({quantity: 123, quantityRemaining: 1, comment: '<string>'})
};
fetch('https://api.decodahealth.com/billing/discounts/saved-item/{discount_id}', 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://api.decodahealth.com/billing/discounts/saved-item/{discount_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'quantity' => 123,
'quantityRemaining' => 1,
'comment' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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://api.decodahealth.com/billing/discounts/saved-item/{discount_id}"
payload := strings.NewReader("{\n \"quantity\": 123,\n \"quantityRemaining\": 1,\n \"comment\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
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.put("https://api.decodahealth.com/billing/discounts/saved-item/{discount_id}")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"quantity\": 123,\n \"quantityRemaining\": 1,\n \"comment\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/billing/discounts/saved-item/{discount_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quantity\": 123,\n \"quantityRemaining\": 1,\n \"comment\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"itemId": "<string>",
"patientId": "<string>",
"quantity": 123,
"quantityRemaining": 123,
"createdDate": "2023-11-07T05:31:56Z",
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"sortOrder": 123,
"allowCustomPricing": false,
"showInCheckOut": true,
"type": "PRODUCT",
"externalId": "<string>",
"exemptedTaxIds": [
"<string>"
],
"cost": 123,
"cashPrice": 123,
"commissionable": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>"
}
],
"hiddenInPatientPortal": false,
"hiddenInOnlineShop": true,
"loyaltyPointsEarned": 1,
"defaultCptCode": "<string>",
"defaultModifiers": [
"<string>"
],
"defaultIcd10Codes": [
"<string>"
],
"defaultPlaceOfService": "<string>"
},
"price": 123,
"createdByChargeItemId": "<string>",
"comment": "<string>",
"usages": [
{
"chargeId": "<string>",
"chargeItemId": "<string>",
"chargeDate": "2023-11-07T05:31:56Z",
"quantityUsed": 123,
"chargeTotal": 123,
"kind": "charge"
}
],
"originatingCharge": {
"id": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"description": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Path Parameters
Body
application/json
Response
Successful Response
Saved item (SAVED_ITEM discount) - compatible with PatientBankedItem for API response.
Show child attributes
Show child attributes
Chronological timeline (newest first) of charge applications and manual adjustments.
A SAVED_ITEM was drawn down by a real charge (DiscountUse → ChargeItems → Charge).
- SavedItemChargeUsage
- SavedItemManualAdjustment
Show child attributes
Show child attributes
The invoice this banked item was minted from (null for staff-granted credits).
Show child attributes
Show child attributes
⌘I
