Skip to main content
GET
/
inventory
/
commission-structures
/
list
List Commission Structures
curl --request GET \
  --url https://api.decodahealth.com/inventory/commission-structures/list \
  --header 'API-KEY: <api-key>' \
  --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>",
            "taxable": false,
            "sortOrder": 123,
            "allowCustomPricing": false,
            "type": "PRODUCT"
          }
        }
      ],
      "providers": [
        {
          "id": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>",
          "createdDate": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "total": 123
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
per_page
integer | null
sort_by
string | null
sort_direction
string | null
location_id
string | null

Response

Successful Response

data
CommissionStructureDetail · object[]
required
total
integer
required