Skip to main content
GET
/
inventory
/
commission-reports
/
list
List Commission Reports
curl --request GET \
  --url https://api.decodahealth.com/inventory/commission-reports/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "id": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "totalPayout": 123,
      "commissionStructureId": "<string>",
      "creatorId": "<string>",
      "creator": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "commissionStructure": {
        "name": "<string>",
        "id": "<string>",
        "description": "<string>"
      },
      "payouts": [
        {
          "commissionReportId": "<string>",
          "commissionId": "<string>",
          "providerId": "<string>",
          "amount": 123,
          "id": "<string>",
          "createdDate": "2023-11-07T05:31:56Z"
        }
      ],
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "isArchived": false
    }
  ],
  "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
CommissionReportSummary · object[]
required
total
integer
required