Getting Started
API
- POSTArchive Banked Item
- PUTArchive Commission Report
- DELArchive Membership
- DELArchive Stock
- DELArchive Supplier
- POSTAssign Provider To Structure
- POSTBill Members
- POSTBulk Assign Providers To Structure
- DELBulk Remove Providers From Structure
- PUTCancel Sold Package
- POSTCreate Banked Item
- POSTCreate Commission Structure
- POSTCreate Item
- POSTCreate Membership
- POSTCreate Package
- POSTCreate Shipments
- POSTCreate Stock
- POSTCreate Stock From Csv
- POSTCreate Stock From Image
- POSTCreate Suppliers
- DELDelete Commission Structure
- DELDelete Item
- DELDelete Package
- DELDelete Shipment
- POSTDrawdown Stock
- POSTDuplicate Commission Structure
- POSTEnroll Member Deferred Billing
- POSTGenerate Commission Report
- GETGet Banked Item
- GETGet Banked Item Charge Items
- GETGet Commission Report
- GETGet Commission Structure
- GETGet Commissions For Provider
- GETGet Inventory Logs
- GETGet Issued Discounts
- GETGet Item Brand Names
- GETGet Member
- GETGet Member Logs
- GETGet Membership
- GETGet Package
- GETGet Package Usage
- GETGet Provider Commission Structures
- GETGet Shipment
- GETGet Sold Package Charge Items
- GETGet Stock
- GETGet Supplier
- POSTLink Stock To Item
- GETList Commission Reports
- GETList Commission Structures
- GETList Item
- GETList Membership Usage
- GETList Memberships
- GETList Packages
- GETList Patient Banked Items
- GETList Patient Packages
- GETList Providers With Commission Structures
- GETList Shipments
- GETList Stocks
- GETList Suppliers
- POSTManual Payment
- DELRemove Provider From Structure
- POSTSave Commission Report
- GETSearch Stocks
- POSTUnfreeze Members
- POSTUnlink Stock From Item
- POSTUpdate Billing Date
- PUTUpdate Commission Structure
- POSTUpdate Discount
- PUTUpdate Item
- POSTUpdate Member Sold By Provider
- PUTUpdate Membership
- PUTUpdate Package
- POSTUpdate Payment Method
- PUTUpdate Shipments
- POSTUpdate Status
- PUTUpdate Stock
- PUTUpdate Supplier
- POST
Tenant
curl --request GET \
--url https://api.decodahealth.com/inventory/logs/{stock_id} \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'[
{
"stockId": "<string>",
"action": "STOCK_CREATED",
"creatorId": "<string>",
"id": "<string>",
"itemId": "<string>",
"quantity": 123,
"chargeId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"shipmentId": "<string>",
"note": "<string>",
"stock": {
"name": "<string>",
"unit": "AMPOULES",
"id": "<string>",
"description": "<string>",
"notes": "<string>",
"category": "<string>",
"isArchived": false
},
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"unit": "AMPOULES",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"taxable": false,
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT",
"stocks": [
{
"itemId": "<string>",
"stockId": "<string>",
"quantityUsed": 123
}
]
},
"charge": {
"patientId": "<string>",
"totalOutstanding": 123,
"id": "<string>",
"patient": {
"id": "<string>",
"type": "PROVIDER",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": true,
"meta": {},
"isArchived": true,
"primaryLocationId": "<string>",
"gender": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": [
"<string>"
],
"onSchedulingBlacklist": true,
"surchargeDisabled": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>"
},
"total": 0,
"description": "<string>",
"status": "OUTSTANDING",
"discountAmount": 0,
"discountPercentage": 0,
"externalId": "<string>",
"externalCreatedDate": "2023-11-07T05:31:56Z",
"ruleSetId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"creatorId": "<string>",
"items": [],
"tips": [],
"locationId": "<string>",
"eventId": "<string>",
"memberId": "<string>",
"comment": "<string>",
"meta": {},
"merchantAccountId": "<string>"
},
"shipment": {
"stockId": "<string>",
"supplierId": "<string>",
"locationId": "<string>",
"quantity": 123,
"remainingQuantity": 123,
"locationName": "<string>",
"id": "<string>",
"lotNumber": "<string>",
"expiryDate": "2023-11-07T05:31:56Z",
"sku": "<string>",
"cost": 123,
"supplier": {
"name": "<string>",
"id": "<string>",
"description": "<string>",
"website": "<string>",
"email": "<string>",
"preferredContactMethod": "<string>",
"phoneNumber": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"isArchived": false
},
"createdDate": "2023-11-07T05:31:56Z",
"note": "<string>"
},
"creator": {
"id": "<string>",
"type": "PROVIDER",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
}
}
]Get Inventory Logs
curl --request GET \
--url https://api.decodahealth.com/inventory/logs/{stock_id} \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'[
{
"stockId": "<string>",
"action": "STOCK_CREATED",
"creatorId": "<string>",
"id": "<string>",
"itemId": "<string>",
"quantity": 123,
"chargeId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"shipmentId": "<string>",
"note": "<string>",
"stock": {
"name": "<string>",
"unit": "AMPOULES",
"id": "<string>",
"description": "<string>",
"notes": "<string>",
"category": "<string>",
"isArchived": false
},
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"unit": "AMPOULES",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"taxable": false,
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT",
"stocks": [
{
"itemId": "<string>",
"stockId": "<string>",
"quantityUsed": 123
}
]
},
"charge": {
"patientId": "<string>",
"totalOutstanding": 123,
"id": "<string>",
"patient": {
"id": "<string>",
"type": "PROVIDER",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": true,
"meta": {},
"isArchived": true,
"primaryLocationId": "<string>",
"gender": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": [
"<string>"
],
"onSchedulingBlacklist": true,
"surchargeDisabled": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>"
},
"total": 0,
"description": "<string>",
"status": "OUTSTANDING",
"discountAmount": 0,
"discountPercentage": 0,
"externalId": "<string>",
"externalCreatedDate": "2023-11-07T05:31:56Z",
"ruleSetId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"creatorId": "<string>",
"items": [],
"tips": [],
"locationId": "<string>",
"eventId": "<string>",
"memberId": "<string>",
"comment": "<string>",
"meta": {},
"merchantAccountId": "<string>"
},
"shipment": {
"stockId": "<string>",
"supplierId": "<string>",
"locationId": "<string>",
"quantity": 123,
"remainingQuantity": 123,
"locationName": "<string>",
"id": "<string>",
"lotNumber": "<string>",
"expiryDate": "2023-11-07T05:31:56Z",
"sku": "<string>",
"cost": 123,
"supplier": {
"name": "<string>",
"id": "<string>",
"description": "<string>",
"website": "<string>",
"email": "<string>",
"preferredContactMethod": "<string>",
"phoneNumber": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"isArchived": false
},
"createdDate": "2023-11-07T05:31:56Z",
"note": "<string>"
},
"creator": {
"id": "<string>",
"type": "PROVIDER",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
}
}
]Headers
The tenant you are making this request on behalf of
Your api key
Path Parameters
Query Parameters
STOCK_CREATED, STOCK_UPDATED, STOCK_ARCHIVED, DRAWDOWN, RESTORED, SHIPMENT_RECEIVED, SHIPMENT_UPDATED, SHIPMENT_ARCHIVED, ITEM_LINKED, ITEM_UNLINKED Response
Successful Response
ID of the stock
Action performed on the stock
STOCK_CREATED, STOCK_UPDATED, STOCK_ARCHIVED, DRAWDOWN, RESTORED, SHIPMENT_RECEIVED, SHIPMENT_UPDATED, SHIPMENT_ARCHIVED, ITEM_LINKED, ITEM_UNLINKED ID of the creator
Unique identifier for the inventory log
ID of the item
Quantity of the stock
ID of the charge
Date and time the log was created
ID of the shipment
Optional note about the inventory action
Stock
Show child attributes
Show child attributes
Name of the stock
Unit of measurement
AMPOULES, APPLICATORS, BOTTLES, BOXES, CAPSULES, CUPS, DOSES, G_PER_ML, GRAMS, IU, IU_PER_ML, OUNCES, FLUID_OUNCES, KG, KITS, LITERS, MCG, MG, MG_PER_ML, ML, MMOL, MICROGRAM_PER_ML, PACKS, PAIRS, PATCHES, PERCENTAGE, PIECES, POUCHES, ROLLS, SACHETS, SHEETS, SPRAYS, STRIPS, SYRINGES, TABLETS, TABLETS_PER_DAY, TESTS, TUBES, UNITS, VIALS, TREATMENTS, SESSIONS, PULSES, JOULES, CENTIMETERS, THREAD_COUNT, INJECTIONS, WRINKLE_UNITS, POUNDS, FEET, INCHES Unique identifier for the stock
Optional description of the stock
Notes about the stock
Category name (references category.name)
Whether the stock is archived
Item
Show child attributes
Show child attributes
Name of the item
Price of the item in cents
Unique identifier for the item
Optional brand name of the item
Optional description of the item
Category name (references category.name)
Unit of measurement for the item
AMPOULES, APPLICATORS, BOTTLES, BOXES, CAPSULES, CUPS, DOSES, G_PER_ML, GRAMS, IU, IU_PER_ML, OUNCES, FLUID_OUNCES, KG, KITS, LITERS, MCG, MG, MG_PER_ML, ML, MMOL, MICROGRAM_PER_ML, PACKS, PAIRS, PATCHES, PERCENTAGE, PIECES, POUCHES, ROLLS, SACHETS, SHEETS, SPRAYS, STRIPS, SYRINGES, TABLETS, TABLETS_PER_DAY, TESTS, TUBES, UNITS, VIALS, TREATMENTS, SESSIONS, PULSES, JOULES, CENTIMETERS, THREAD_COUNT, INJECTIONS, WRINKLE_UNITS, POUNDS, FEET, INCHES Whether the item is physical
Whether the item is archived
Optional internal notes for the item
Whether the item is subject to taxes
Optional sort order for the item
Whether custom pricing is allowed for this item
Type of item (PRODUCT, MEDICATION, etc.)
ITEM, PRODUCT, MEDICATION, SERVICE, PACKAGE, MEMBERSHIP Charge
Show child attributes
Show child attributes
Identifier of the patient being charged.
Total outstanding amount that is yet to be paid.
A unique identifier for the charge. Auto-generated if not provided.
Summary details of the patient being charged.
Show child attributes
Show child attributes
The unique identifier for the user.
The type of user.
PROVIDER, PATIENT, ASSISTANT The date and time when the user was created.
The user's first name.
The user's last name.
The user's phone number.
The user's email address.
The location of the user.
The user's external identifier if available.
The user's primary address.
Additional address information.
The city of the user's address.
The state of the user's address.
The postal code of the user's address.
The country of the user's address.
Whether the user's address is valid.
Any additional metadata about the user relevant to your system.
Whether the user is archived.
The primary location of the user.
The gender of the patient.
The date of birth of the patient.
List of patient's self-reported medications.
Whether the patient is on the scheduling blacklist.
Whether surcharges are disabled for this patient.
List of patient tags
Show child attributes
Show child attributes
Unique identifier for the patient tag
Name of the patient tag
Whether the tag is active
Date and time when the tag was created
Emoji associated with the tag
Color code for the tag (hex format)
Date and time when the tag was last updated
Patient's credit balance in cents.
The preferred provider ID for this patient.
Total amount of the charge.
Description of the charge.
Current status of the charge.
OUTSTANDING, PAID, EXTERNAL_SETTLEMENT, VOID, WRITE_OFF, REFUNDED, CHARGEBACK, PAYMENT_PLAN, COLLECTIONS Any discount applied to the total outstanding.
Percentage of discount applied to the charge.
External identifier for the charge, if applicable.
The creation date of the charge in your external system, if applicable.
Identifier for the RuleSet applied to this Charge, if any.
The date when the charge was created.
Identifier of the Provider who created the charge (i.e. the Clinician, or relevant Biller).
List of Items in the Charge.
Show child attributes
Show child attributes
Identifier of the charge this item is associated with
Quantity of the item being charged
Price of the item in cents
Unique identifier for the charge item
Optional unique identifier for the item
Name of the item (None for items with associated inventory item)
Description of the item
Discount amount for the item
Discount percentage for the item
Reason for discount
Unique identifier for the sold package usage
Quantity to bank for later use
ID of banked item being used (for tracking usage)
Unique identifier for the specific issued discount instance used
Unique identifier for the provider who sold the item
Tax amount for the item in cents
Unique identifier for the pricing for the item
Optional list of shipment IDs to reduce the stock quantity of
List of Tips in the Charge.
Show child attributes
Show child attributes
Charge ID this tip belongs to
Tip amount in cents
Provider ID receiving the tip
Unique identifier for the tip
Identifier of the Location where the charge was created.
Identifier of the Event this charge is associated with, if any.
Identifier of the Member this charge is associated with, if any.
Any additional comments about the charge.
Any additional metadata about the charge relevant to your system.
Identifier of the MerchantAccount this charge is associated with.
Shipment
Show child attributes
Show child attributes
ID of the stock
ID of the supplier
ID of the location where the shipment was delivered
Total quantity
Remaining quantity
Get the location name from the related location object
Unique identifier for the shipment
Optional lot number of the shipment
Optional expiry date of the shipment
Optional SKU (Stock Keeping Unit)
Cost of the shipment in cents
Optional supplier details
Show child attributes
Show child attributes
Name of the supplier
Unique identifier for the supplier
Optional description of the supplier
Optional website of the supplier
Optional email of the supplier
Optional preferred contact method
Optional phone number of the supplier
Optional first line of address
Optional second line of address
Optional city
Optional state or province
Optional ZIP or postal code
Optional country
Whether the supplier is archived
Date and time the shipment was created
Optional note for inventory log when updating shipment
Creator
Show child attributes
Show child attributes
The unique identifier for the user.
The type of user.
PROVIDER, PATIENT, ASSISTANT The user's first name.
The user's last name.
The user's phone number.
The user's email address.
The location of the user.