Getting Started
API
- POSTArchive Banked Item
- DELArchive Membership
- DELArchive Purchase Order
- DELArchive Stock
- DELArchive Supplier
- POSTAssign Provider To Structure
- POSTBill Members
- POSTBulk Assign Providers To Structure
- DELBulk Remove Providers From Structure
- POSTBulk Update Item Taxes
- POSTCancel Purchase Order
- PUTCancel Sold Package
- POSTCreate Banked Item
- POSTCreate Commission Structure
- POSTCreate Item
- POSTCreate Membership
- POSTCreate Package
- POSTCreate Purchase Order
- 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
- POSTFreeze Members
- POSTFreeze Membership
- POSTGenerate Commission Report
- GETGet Banked Item
- GETGet Banked Item Charge Items
- 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 Purchase Order
- GETGet Shipment
- GETGet Sold Package Charge Items
- GETGet Stock
- GETGet Supplier
- POSTLink Stock To Item
- POSTLink Supplier To Stock
- 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 Purchase Orders
- GETList Shipments
- GETList Stocks
- GETList Suppliers
- POSTManual Payment
- POSTPlace Purchase Order
- DELRemove Provider From Structure
- GETSearch Stocks
- POSTTake Delivery
- POSTUnfreeze Members
- POSTUnlink Stock From Item
- POSTUnlink Supplier From Stock
- POSTUpdate Billing Date
- PUTUpdate Commission Structure
- POSTUpdate Discount
- PUTUpdate Item
- POSTUpdate Member Sold By Provider
- PUTUpdate Membership
- PUTUpdate Package
- POSTUpdate Payment Method
- PATCHUpdate Purchase Order
- PUTUpdate Shipments
- POSTUpdate Status
- PUTUpdate Stock
- PUTUpdate Supplier
- POST
Tenant
Update Commission Structure
Copy
curl --request PUT \
--url https://api.decodahealth.com/inventory/commission-structures/{commission_structure_id} \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"name": "<string>",
"id": "<string>",
"description": "<string>",
"commissions": [
{
"commissionStructureId": "<string>",
"id": "<string>",
"itemId": "<string>",
"itemCategory": "<string>",
"itemIsPhysical": true,
"totalSalesAmount": 123,
"percentage": 123,
"amount": 123,
"deductCost": false,
"isArchived": false,
"updatedDate": "2023-11-07T05:31:56Z",
"createdDate": "2023-11-07T05:31:56Z",
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"unit": "AMPOULES",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT",
"externalId": "<string>",
"exemptedTaxIds": [
"<string>"
]
}
}
],
"providers": [
{
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}
]
}
'Copy
{
"name": "<string>",
"id": "<string>",
"description": "<string>",
"commissions": [
{
"commissionStructureId": "<string>",
"id": "<string>",
"itemId": "<string>",
"itemCategory": "<string>",
"itemIsPhysical": true,
"totalSalesAmount": 123,
"percentage": 123,
"amount": 123,
"deductCost": false,
"isArchived": false,
"updatedDate": "2023-11-07T05:31:56Z",
"createdDate": "2023-11-07T05:31:56Z",
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"unit": "AMPOULES",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT",
"externalId": "<string>",
"exemptedTaxIds": [
"<string>"
]
}
}
],
"providers": [
{
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}
]
}Inventory
Update Commission Structure
Update a commission structure and all its commissions
PUT
/
inventory
/
commission-structures
/
{commission_structure_id}
Update Commission Structure
Copy
curl --request PUT \
--url https://api.decodahealth.com/inventory/commission-structures/{commission_structure_id} \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"name": "<string>",
"id": "<string>",
"description": "<string>",
"commissions": [
{
"commissionStructureId": "<string>",
"id": "<string>",
"itemId": "<string>",
"itemCategory": "<string>",
"itemIsPhysical": true,
"totalSalesAmount": 123,
"percentage": 123,
"amount": 123,
"deductCost": false,
"isArchived": false,
"updatedDate": "2023-11-07T05:31:56Z",
"createdDate": "2023-11-07T05:31:56Z",
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"unit": "AMPOULES",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT",
"externalId": "<string>",
"exemptedTaxIds": [
"<string>"
]
}
}
],
"providers": [
{
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}
]
}
'Copy
{
"name": "<string>",
"id": "<string>",
"description": "<string>",
"commissions": [
{
"commissionStructureId": "<string>",
"id": "<string>",
"itemId": "<string>",
"itemCategory": "<string>",
"itemIsPhysical": true,
"totalSalesAmount": 123,
"percentage": 123,
"amount": 123,
"deductCost": false,
"isArchived": false,
"updatedDate": "2023-11-07T05:31:56Z",
"createdDate": "2023-11-07T05:31:56Z",
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"unit": "AMPOULES",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT",
"externalId": "<string>",
"exemptedTaxIds": [
"<string>"
]
}
}
],
"providers": [
{
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Path Parameters
Body
application/json
Name of the commission group
Unique identifier for the commission group
Optional description of the commission group
Commissions in this group
Show child attributes
Show child attributes
Providers in this group
Show child attributes
Show child attributes
Response
Successful Response
Name of the commission group
Unique identifier for the commission group
Optional description of the commission group
Commissions in this group
Show child attributes
Show child attributes
Providers in this group
Show child attributes
Show child attributes
⌘I