curl --request POST \
--url https://api.decodahealth.com/inventory/banked-items/create \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"itemId": "<string>",
"patientId": "<string>",
"createdByChargeItemId": "<string>",
"quantity": 123,
"quantityRemaining": 123,
"id": "<string>",
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"taxable": false,
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT"
},
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.decodahealth.com/inventory/banked-items/create"
payload = {
"itemId": "<string>",
"patientId": "<string>",
"createdByChargeItemId": "<string>",
"quantity": 123,
"quantityRemaining": 123,
"id": "<string>",
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"isPhysical": True,
"isArchived": False,
"internalNotes": "<string>",
"taxable": False,
"sortOrder": 123,
"allowCustomPricing": False,
"type": "PRODUCT"
},
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z"
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
itemId: '<string>',
patientId: '<string>',
createdByChargeItemId: '<string>',
quantity: 123,
quantityRemaining: 123,
id: '<string>',
item: {
name: '<string>',
price: 123,
id: '<string>',
brandName: '<string>',
description: '<string>',
category: '<string>',
isPhysical: true,
isArchived: false,
internalNotes: '<string>',
taxable: false,
sortOrder: 123,
allowCustomPricing: false,
type: 'PRODUCT'
},
createdDate: '2023-11-07T05:31:56Z',
updatedDate: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.decodahealth.com/inventory/banked-items/create', 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/inventory/banked-items/create",
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([
'itemId' => '<string>',
'patientId' => '<string>',
'createdByChargeItemId' => '<string>',
'quantity' => 123,
'quantityRemaining' => 123,
'id' => '<string>',
'item' => [
'name' => '<string>',
'price' => 123,
'id' => '<string>',
'brandName' => '<string>',
'description' => '<string>',
'category' => '<string>',
'isPhysical' => true,
'isArchived' => false,
'internalNotes' => '<string>',
'taxable' => false,
'sortOrder' => 123,
'allowCustomPricing' => false,
'type' => 'PRODUCT'
],
'createdDate' => '2023-11-07T05:31:56Z',
'updatedDate' => '2023-11-07T05:31:56Z'
]),
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/inventory/banked-items/create"
payload := strings.NewReader("{\n \"itemId\": \"<string>\",\n \"patientId\": \"<string>\",\n \"createdByChargeItemId\": \"<string>\",\n \"quantity\": 123,\n \"quantityRemaining\": 123,\n \"id\": \"<string>\",\n \"item\": {\n \"name\": \"<string>\",\n \"price\": 123,\n \"id\": \"<string>\",\n \"brandName\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"isPhysical\": true,\n \"isArchived\": false,\n \"internalNotes\": \"<string>\",\n \"taxable\": false,\n \"sortOrder\": 123,\n \"allowCustomPricing\": false,\n \"type\": \"PRODUCT\"\n },\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.decodahealth.com/inventory/banked-items/create")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"itemId\": \"<string>\",\n \"patientId\": \"<string>\",\n \"createdByChargeItemId\": \"<string>\",\n \"quantity\": 123,\n \"quantityRemaining\": 123,\n \"id\": \"<string>\",\n \"item\": {\n \"name\": \"<string>\",\n \"price\": 123,\n \"id\": \"<string>\",\n \"brandName\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"isPhysical\": true,\n \"isArchived\": false,\n \"internalNotes\": \"<string>\",\n \"taxable\": false,\n \"sortOrder\": 123,\n \"allowCustomPricing\": false,\n \"type\": \"PRODUCT\"\n },\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/inventory/banked-items/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"itemId\": \"<string>\",\n \"patientId\": \"<string>\",\n \"createdByChargeItemId\": \"<string>\",\n \"quantity\": 123,\n \"quantityRemaining\": 123,\n \"id\": \"<string>\",\n \"item\": {\n \"name\": \"<string>\",\n \"price\": 123,\n \"id\": \"<string>\",\n \"brandName\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"isPhysical\": true,\n \"isArchived\": false,\n \"internalNotes\": \"<string>\",\n \"taxable\": false,\n \"sortOrder\": 123,\n \"allowCustomPricing\": false,\n \"type\": \"PRODUCT\"\n },\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"itemId": "<string>",
"patientId": "<string>",
"createdByChargeItemId": "<string>",
"quantity": 123,
"quantityRemaining": 123,
"id": "<string>",
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"taxable": false,
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT"
},
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Create Banked Item
Create a new banked item. Can be created from a charge item or manually.
curl --request POST \
--url https://api.decodahealth.com/inventory/banked-items/create \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"itemId": "<string>",
"patientId": "<string>",
"createdByChargeItemId": "<string>",
"quantity": 123,
"quantityRemaining": 123,
"id": "<string>",
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"taxable": false,
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT"
},
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.decodahealth.com/inventory/banked-items/create"
payload = {
"itemId": "<string>",
"patientId": "<string>",
"createdByChargeItemId": "<string>",
"quantity": 123,
"quantityRemaining": 123,
"id": "<string>",
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"isPhysical": True,
"isArchived": False,
"internalNotes": "<string>",
"taxable": False,
"sortOrder": 123,
"allowCustomPricing": False,
"type": "PRODUCT"
},
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z"
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
itemId: '<string>',
patientId: '<string>',
createdByChargeItemId: '<string>',
quantity: 123,
quantityRemaining: 123,
id: '<string>',
item: {
name: '<string>',
price: 123,
id: '<string>',
brandName: '<string>',
description: '<string>',
category: '<string>',
isPhysical: true,
isArchived: false,
internalNotes: '<string>',
taxable: false,
sortOrder: 123,
allowCustomPricing: false,
type: 'PRODUCT'
},
createdDate: '2023-11-07T05:31:56Z',
updatedDate: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.decodahealth.com/inventory/banked-items/create', 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/inventory/banked-items/create",
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([
'itemId' => '<string>',
'patientId' => '<string>',
'createdByChargeItemId' => '<string>',
'quantity' => 123,
'quantityRemaining' => 123,
'id' => '<string>',
'item' => [
'name' => '<string>',
'price' => 123,
'id' => '<string>',
'brandName' => '<string>',
'description' => '<string>',
'category' => '<string>',
'isPhysical' => true,
'isArchived' => false,
'internalNotes' => '<string>',
'taxable' => false,
'sortOrder' => 123,
'allowCustomPricing' => false,
'type' => 'PRODUCT'
],
'createdDate' => '2023-11-07T05:31:56Z',
'updatedDate' => '2023-11-07T05:31:56Z'
]),
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/inventory/banked-items/create"
payload := strings.NewReader("{\n \"itemId\": \"<string>\",\n \"patientId\": \"<string>\",\n \"createdByChargeItemId\": \"<string>\",\n \"quantity\": 123,\n \"quantityRemaining\": 123,\n \"id\": \"<string>\",\n \"item\": {\n \"name\": \"<string>\",\n \"price\": 123,\n \"id\": \"<string>\",\n \"brandName\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"isPhysical\": true,\n \"isArchived\": false,\n \"internalNotes\": \"<string>\",\n \"taxable\": false,\n \"sortOrder\": 123,\n \"allowCustomPricing\": false,\n \"type\": \"PRODUCT\"\n },\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.decodahealth.com/inventory/banked-items/create")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"itemId\": \"<string>\",\n \"patientId\": \"<string>\",\n \"createdByChargeItemId\": \"<string>\",\n \"quantity\": 123,\n \"quantityRemaining\": 123,\n \"id\": \"<string>\",\n \"item\": {\n \"name\": \"<string>\",\n \"price\": 123,\n \"id\": \"<string>\",\n \"brandName\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"isPhysical\": true,\n \"isArchived\": false,\n \"internalNotes\": \"<string>\",\n \"taxable\": false,\n \"sortOrder\": 123,\n \"allowCustomPricing\": false,\n \"type\": \"PRODUCT\"\n },\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/inventory/banked-items/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"itemId\": \"<string>\",\n \"patientId\": \"<string>\",\n \"createdByChargeItemId\": \"<string>\",\n \"quantity\": 123,\n \"quantityRemaining\": 123,\n \"id\": \"<string>\",\n \"item\": {\n \"name\": \"<string>\",\n \"price\": 123,\n \"id\": \"<string>\",\n \"brandName\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"isPhysical\": true,\n \"isArchived\": false,\n \"internalNotes\": \"<string>\",\n \"taxable\": false,\n \"sortOrder\": 123,\n \"allowCustomPricing\": false,\n \"type\": \"PRODUCT\"\n },\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"itemId": "<string>",
"patientId": "<string>",
"createdByChargeItemId": "<string>",
"quantity": 123,
"quantityRemaining": 123,
"id": "<string>",
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"taxable": false,
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT"
},
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Body
Item ID that was banked
Patient ID who purchased the item
Charge item ID that created this banked item
Total quantity banked
Quantity still available
Unique identifier for the banked item
Details of the item
Show child attributes
Show child attributes
Date the item was banked (auto-set if not provided)
Date the item was updated
Response
Successful Response
Item ID that was banked
Patient ID who purchased the item
Charge item ID that created this banked item
Total quantity banked
Quantity still available
Unique identifier for the banked item
Details of the item
Show child attributes
Show child attributes
Date the item was banked (auto-set if not provided)
Date the item was updated
