Get Commissions For Provider

curl --request GET \
  --url https://api.decodahealth.com/inventory/providers/{provider_id}/commissions \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

[
  {
    "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>",
      "taxable": false,
      "sortOrder": 123,
      "allowCustomPricing": false,
      "type": "PRODUCT"
    }
  }
]

GET

inventory

providers

{provider_id}

commissions

Get Commissions For Provider

curl --request GET \
  --url https://api.decodahealth.com/inventory/providers/{provider_id}/commissions \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

[
  {
    "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>",
      "taxable": false,
      "sortOrder": 123,
      "allowCustomPricing": false,
      "type": "PRODUCT"
    }
  }
]

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Path Parameters

provider_id

string

required

Response

Successful Response

commissionStructureId

string

required

Commission structure this commission belongs to

string

Unique identifier for the commission

itemId

string | null

Optional item this commission applies to (includes services and packages)

itemCategory

string | null

Optional category name this commission applies to (references category.name)

itemIsPhysical

boolean | null

Optional filter by whether item is physical

totalSalesAmount

integer | null

Optional minimum total sales amount threshold in cents

percentage

number | null

Commission percentage (0.0 to 1.0)

amount

integer | null

Fixed commission amount in cents

deductCost

boolean

default:false

Whether to deduct cost_of_service before calculating commission (services only)

isArchived

boolean

default:false

Whether the commission is archived

updatedDate

string<date-time> | null

When the commission was last updated

createdDate

string<date-time> | null

When the commission was created

item

ItemTiny · object

Associated item (includes services and packages)

Show child attributes

item.name

string

required

Name of the item

item.price

integer

required

Price of the item in cents

item.id

string

Unique identifier for the item

item.brandName

string | null

Optional brand name of the item

item.description

string | null

Optional description of the item

item.category

string | null

Category name (references category.name)

item.unit

enum<string> | null

Unit of measurement for the item

Available options:

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

item.isPhysical

boolean

default:true

Whether the item is physical

item.isArchived

boolean

default:false

Whether the item is archived

item.internalNotes

string | null

Optional internal notes for the item

item.taxable

boolean

default:false

Whether the item is subject to taxes

item.sortOrder

integer | null

Optional sort order for the item

item.allowCustomPricing

boolean

default:false

Whether custom pricing is allowed for this item

item.type

enum<string>

default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:

ITEM,

PRODUCT,

MEDICATION,

SERVICE,

PACKAGE,

MEMBERSHIP

Get Commission Structure Get Inventory Logs

⌘I

Getting Started

API

Tenant

Webhook

Get Commissions For Provider

Headers

Path Parameters

Response