Get Commission Report

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

{
  "commissionStructure": {
    "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"
      }
    ]
  },
  "startDate": "2023-12-25",
  "endDate": "2023-12-25",
  "payouts": [
    {
      "commissionReportId": "<string>",
      "commissionId": "<string>",
      "providerId": "<string>",
      "amount": 123,
      "provider": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "commission": {
        "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"
        }
      },
      "chargeItems": [
        {
          "chargeId": "<string>",
          "quantity": 123,
          "price": 123,
          "id": "<string>",
          "itemId": "<string>",
          "name": "<string>",
          "description": "<string>",
          "discountAmount": 123,
          "discountPercentage": 123,
          "discountReason": "<string>",
          "soldPackageId": "<string>",
          "bankedQuantity": 123,
          "bankedItemId": "<string>",
          "issuedDiscountId": "<string>",
          "soldByProviderId": "<string>",
          "taxAmount": 123,
          "pricingId": "<string>",
          "shipmentIds": [
            "<string>"
          ],
          "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"
          },
          "locationId": "<string>",
          "locationName": "<string>",
          "saleDate": "2023-11-07T05:31:56Z"
        }
      ],
      "events": [
        {
          "id": "<string>",
          "title": "<string>",
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z",
          "type": "APPOINTMENT",
          "status": "PENDING",
          "location": {
            "id": "<string>",
            "isVirtual": true
          },
          "attendees": [],
          "recurringEventId": "<string>",
          "recurringEvent": {
            "id": "<string>",
            "rrule": "<string>",
            "startDate": "2023-11-07T05:31:56Z",
            "durationMinutes": 123,
            "timezone": "<string>",
            "type": "APPOINTMENT",
            "title": "<string>",
            "organizerId": "<string>",
            "serviceIds": [
              "<string>"
            ],
            "capacity": 123,
            "attendeeIds": [
              "<string>"
            ],
            "locationId": "<string>"
          },
          "eventServices": [],
          "icons": [],
          "capacity": 123
        }
      ],
      "soldPackages": [
        {
          "packageId": "<string>",
          "patientId": "<string>",
          "chargeItemId": "<string>",
          "status": "USED",
          "createdDate": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "package": {
            "name": "<string>",
            "price": 123,
            "id": "<string>",
            "description": "<string>",
            "isArchived": false,
            "internalNotes": "<string>",
            "items": [
              {
                "packageId": "<string>",
                "itemId": "<string>",
                "price": 123,
                "id": "<string>",
                "quantity": 123,
                "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"
                }
              }
            ],
            "category": "<string>"
          },
          "updatedDate": "2023-11-07T05:31:56Z"
        }
      ],
      "id": "<string>",
      "createdDate": "2023-11-07T05:31:56Z"
    }
  ],
  "totalPayout": 123,
  "commissionStructureId": "<string>",
  "creatorId": "<string>",
  "id": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "isArchived": false
}

GET

inventory

commission-reports

{report_id}

Get Commission Report

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

{
  "commissionStructure": {
    "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"
      }
    ]
  },
  "startDate": "2023-12-25",
  "endDate": "2023-12-25",
  "payouts": [
    {
      "commissionReportId": "<string>",
      "commissionId": "<string>",
      "providerId": "<string>",
      "amount": 123,
      "provider": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "commission": {
        "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"
        }
      },
      "chargeItems": [
        {
          "chargeId": "<string>",
          "quantity": 123,
          "price": 123,
          "id": "<string>",
          "itemId": "<string>",
          "name": "<string>",
          "description": "<string>",
          "discountAmount": 123,
          "discountPercentage": 123,
          "discountReason": "<string>",
          "soldPackageId": "<string>",
          "bankedQuantity": 123,
          "bankedItemId": "<string>",
          "issuedDiscountId": "<string>",
          "soldByProviderId": "<string>",
          "taxAmount": 123,
          "pricingId": "<string>",
          "shipmentIds": [
            "<string>"
          ],
          "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"
          },
          "locationId": "<string>",
          "locationName": "<string>",
          "saleDate": "2023-11-07T05:31:56Z"
        }
      ],
      "events": [
        {
          "id": "<string>",
          "title": "<string>",
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z",
          "type": "APPOINTMENT",
          "status": "PENDING",
          "location": {
            "id": "<string>",
            "isVirtual": true
          },
          "attendees": [],
          "recurringEventId": "<string>",
          "recurringEvent": {
            "id": "<string>",
            "rrule": "<string>",
            "startDate": "2023-11-07T05:31:56Z",
            "durationMinutes": 123,
            "timezone": "<string>",
            "type": "APPOINTMENT",
            "title": "<string>",
            "organizerId": "<string>",
            "serviceIds": [
              "<string>"
            ],
            "capacity": 123,
            "attendeeIds": [
              "<string>"
            ],
            "locationId": "<string>"
          },
          "eventServices": [],
          "icons": [],
          "capacity": 123
        }
      ],
      "soldPackages": [
        {
          "packageId": "<string>",
          "patientId": "<string>",
          "chargeItemId": "<string>",
          "status": "USED",
          "createdDate": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "package": {
            "name": "<string>",
            "price": 123,
            "id": "<string>",
            "description": "<string>",
            "isArchived": false,
            "internalNotes": "<string>",
            "items": [
              {
                "packageId": "<string>",
                "itemId": "<string>",
                "price": 123,
                "id": "<string>",
                "quantity": 123,
                "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"
                }
              }
            ],
            "category": "<string>"
          },
          "updatedDate": "2023-11-07T05:31:56Z"
        }
      ],
      "id": "<string>",
      "createdDate": "2023-11-07T05:31:56Z"
    }
  ],
  "totalPayout": 123,
  "commissionStructureId": "<string>",
  "creatorId": "<string>",
  "id": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "isArchived": false
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Path Parameters

report_id

string

required

Response

Successful Response

commissionStructure

CommissionStructureDetail · object

required

Commission structure this report belongs to

Show child attributes

commissionStructure.name

string

required

Name of the commission group

commissionStructure.id

string

Unique identifier for the commission group

commissionStructure.description

string | null

Optional description of the commission group

commissionStructure.commissions

CommissionDetail · object[] | null

Commissions in this group

Show child attributes

commissionStructure.commissions.commissionStructureId

string

required

Commission structure this commission belongs to

commissionStructure.commissions.id

string

Unique identifier for the commission

commissionStructure.commissions.itemId

string | null

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

commissionStructure.commissions.itemCategory

string | null

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

commissionStructure.commissions.itemIsPhysical

boolean | null

Optional filter by whether item is physical

commissionStructure.commissions.totalSalesAmount

integer | null

Optional minimum total sales amount threshold in cents

commissionStructure.commissions.percentage

number | null

Commission percentage (0.0 to 1.0)

commissionStructure.commissions.amount

integer | null

Fixed commission amount in cents

commissionStructure.commissions.deductCost

boolean

default:false

Whether to deduct cost_of_service before calculating commission (services only)

commissionStructure.commissions.isArchived

boolean

default:false

Whether the commission is archived

commissionStructure.commissions.updatedDate

string<date-time> | null

When the commission was last updated

commissionStructure.commissions.createdDate

string<date-time> | null

When the commission was created

commissionStructure.commissions.item

ItemTiny · object

Associated item (includes services and packages)

Show child attributes

commissionStructure.commissions.item.name

string

required

Name of the item

commissionStructure.commissions.item.price

integer

required

Price of the item in cents

commissionStructure.commissions.item.id

string

Unique identifier for the item

commissionStructure.commissions.item.brandName

string | null

Optional brand name of the item

commissionStructure.commissions.item.description

string | null

Optional description of the item

commissionStructure.commissions.item.category

string | null

Category name (references category.name)

commissionStructure.commissions.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

commissionStructure.commissions.item.isPhysical

boolean

default:true

Whether the item is physical

commissionStructure.commissions.item.isArchived

boolean

default:false

Whether the item is archived

commissionStructure.commissions.item.internalNotes

string | null

Optional internal notes for the item

commissionStructure.commissions.item.taxable

boolean

default:false

Whether the item is subject to taxes

commissionStructure.commissions.item.sortOrder

integer | null

Optional sort order for the item

commissionStructure.commissions.item.allowCustomPricing

boolean

default:false

Whether custom pricing is allowed for this item

commissionStructure.commissions.item.type

enum<string>

default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:

ITEM,

PRODUCT,

MEDICATION,

SERVICE,

PACKAGE,

MEMBERSHIP

commissionStructure.providers

ProviderTiny · object[] | null

Providers in this group

Show child attributes

commissionStructure.providers.id

string

required

commissionStructure.providers.firstName

string

required

commissionStructure.providers.lastName

string | null

commissionStructure.providers.email

string | null

commissionStructure.providers.createdDate

string<date-time> | null

startDate

string<date>

required

Start date of the report

endDate

string<date>

required

End date of the report

payouts

CommissionPayoutDetail · object[]

required

Payouts for this commission structure

Show child attributes

payouts.commissionReportId

string

required

Commission report this payout belongs to

payouts.commissionId

string

required

Commission this payout belongs to

payouts.providerId

string

required

Provider this payout belongs to

payouts.amount

integer

required

Amount of the payout

payouts.provider

ProviderTiny · object

required

Provider this payout belongs to

Show child attributes

payouts.provider.id

string

required

payouts.provider.firstName

string

required

payouts.provider.lastName

string | null

payouts.provider.email

string | null

payouts.provider.createdDate

string<date-time> | null

payouts.commission

CommissionDetail · object

required

Commission rule that generated this payout

Show child attributes

payouts.commission.commissionStructureId

string

required

Commission structure this commission belongs to

payouts.commission.id

string

Unique identifier for the commission

payouts.commission.itemId

string | null

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

payouts.commission.itemCategory

string | null

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

payouts.commission.itemIsPhysical

boolean | null

Optional filter by whether item is physical

payouts.commission.totalSalesAmount

integer | null

Optional minimum total sales amount threshold in cents

payouts.commission.percentage

number | null

Commission percentage (0.0 to 1.0)

payouts.commission.amount

integer | null

Fixed commission amount in cents

payouts.commission.deductCost

boolean

default:false

Whether to deduct cost_of_service before calculating commission (services only)

payouts.commission.isArchived

boolean

default:false

Whether the commission is archived

payouts.commission.updatedDate

string<date-time> | null

When the commission was last updated

payouts.commission.createdDate

string<date-time> | null

When the commission was created

payouts.commission.item

ItemTiny · object

Associated item (includes services and packages)

Show child attributes

payouts.commission.item.name

string

required

Name of the item

payouts.commission.item.price

integer

required

Price of the item in cents

payouts.commission.item.id

string

Unique identifier for the item

payouts.commission.item.brandName

string | null

Optional brand name of the item

payouts.commission.item.description

string | null

Optional description of the item

payouts.commission.item.category

string | null

Category name (references category.name)

payouts.commission.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

payouts.commission.item.isPhysical

boolean

default:true

Whether the item is physical

payouts.commission.item.isArchived

boolean

default:false

Whether the item is archived

payouts.commission.item.internalNotes

string | null

Optional internal notes for the item

payouts.commission.item.taxable

boolean

default:false

Whether the item is subject to taxes

payouts.commission.item.sortOrder

integer | null

Optional sort order for the item

payouts.commission.item.allowCustomPricing

boolean

default:false

Whether custom pricing is allowed for this item

payouts.commission.item.type

enum<string>

default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:

ITEM,

PRODUCT,

MEDICATION,

SERVICE,

PACKAGE,

MEMBERSHIP

payouts.chargeItems

ChargeItemDetail · object[]

required

Charges this payout is from

Show child attributes

payouts.chargeItems.chargeId

string

required

Identifier of the charge this item is associated with

payouts.chargeItems.quantity

integer

required

Quantity of the item being charged

payouts.chargeItems.price

integer

required

Price of the item in cents

payouts.chargeItems.id

string | null

Unique identifier for the charge item

payouts.chargeItems.itemId

string | null

Optional unique identifier for the item

payouts.chargeItems.name

string | null

Name of the item (None for items with associated inventory item)

payouts.chargeItems.description

string | null

Description of the item

payouts.chargeItems.discountAmount

integer | null

Discount amount for the item

payouts.chargeItems.discountPercentage

number | null

Discount percentage for the item

payouts.chargeItems.discountReason

string | null

Reason for discount

payouts.chargeItems.soldPackageId

string | null

Unique identifier for the sold package usage

payouts.chargeItems.bankedQuantity

integer | null

Quantity to bank for later use

payouts.chargeItems.bankedItemId

string | null

ID of banked item being used (for tracking usage)

payouts.chargeItems.issuedDiscountId

string | null

Unique identifier for the specific issued discount instance used

payouts.chargeItems.soldByProviderId

string | null

Unique identifier for the provider who sold the item

payouts.chargeItems.taxAmount

integer | null

Tax amount for the item in cents

payouts.chargeItems.pricingId

string | null

Unique identifier for the pricing for the item

payouts.chargeItems.shipmentIds

string[] | null

Optional list of shipment IDs to reduce the stock quantity of

payouts.chargeItems.item

ItemTiny · object

Details of the item (None for custom charge items)

Show child attributes

payouts.chargeItems.item.name

string

required

Name of the item

payouts.chargeItems.item.price

integer

required

Price of the item in cents

payouts.chargeItems.item.id

string

Unique identifier for the item

payouts.chargeItems.item.brandName

string | null

Optional brand name of the item

payouts.chargeItems.item.description

string | null

Optional description of the item

payouts.chargeItems.item.category

string | null

Category name (references category.name)

payouts.chargeItems.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

payouts.chargeItems.item.isPhysical

boolean

default:true

Whether the item is physical

payouts.chargeItems.item.isArchived

boolean

default:false

Whether the item is archived

payouts.chargeItems.item.internalNotes

string | null

Optional internal notes for the item

payouts.chargeItems.item.taxable

boolean

default:false

Whether the item is subject to taxes

payouts.chargeItems.item.sortOrder

integer | null

Optional sort order for the item

payouts.chargeItems.item.allowCustomPricing

boolean

default:false

Whether custom pricing is allowed for this item

payouts.chargeItems.item.type

enum<string>

default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:

ITEM,

PRODUCT,

MEDICATION,

SERVICE,

PACKAGE,

MEMBERSHIP

payouts.chargeItems.locationId

string | null

Location ID where the sale occurred

payouts.chargeItems.locationName

string | null

Location name where the sale occurred

payouts.chargeItems.saleDate

string<date-time> | null

Date when the sale occurred

payouts.events

EventTiny · object[]

required

Events this payout is from

Show child attributes

payouts.events.id

string

required

payouts.events.title

string

required

payouts.events.start

string<date-time>

required

payouts.events.end

string<date-time>

required

payouts.events.type

enum<string>

required

Available options:

APPOINTMENT,

SHIFT,

BLOCK

payouts.events.status

enum<string>

required

Available options:

PENDING,

RESERVED,

CONFIRMED,

CANCELLED,

COMPLETED,

OVERRIDABLE,

NO_SHOW

payouts.events.location

LocationTiny · object

Show child attributes

payouts.events.location.id

string

required

payouts.events.location.isVirtual

boolean

required

payouts.events.attendees

AttendeeDetail · object[]

Show child attributes

payouts.events.attendees.user

UserTiny · object

required

Show child attributes

payouts.events.attendees.user.id

string

required

The unique identifier for the user.

payouts.events.attendees.user.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

payouts.events.attendees.user.firstName

string | null

The user's first name.

payouts.events.attendees.user.lastName

string | null

The user's last name.

payouts.events.attendees.user.phoneNumber

string | null

The user's phone number.

payouts.events.attendees.user.email

string | null

The user's email address.

payouts.events.attendees.user.locationId

string | null

The location of the user.

payouts.events.attendees.inviteStatus

enum<string>

required

Available options:

PENDING,

ACCEPTED,

REJECTED

payouts.events.recurringEventId

string | null

payouts.events.recurringEvent

RecurringEventDetail · object

Show child attributes

payouts.events.recurringEvent.id

string

required

payouts.events.recurringEvent.rrule

string

required

payouts.events.recurringEvent.startDate

string<date-time>

required

payouts.events.recurringEvent.durationMinutes

integer

required

payouts.events.recurringEvent.timezone

string

required

payouts.events.recurringEvent.type

enum<string>

required

Available options:

APPOINTMENT,

SHIFT,

BLOCK

payouts.events.recurringEvent.title

string

required

payouts.events.recurringEvent.organizerId

string

required

payouts.events.recurringEvent.serviceIds

string[] | null

payouts.events.recurringEvent.capacity

integer | null

payouts.events.recurringEvent.attendeeIds

string[] | null

payouts.events.recurringEvent.locationId

string | null

payouts.events.eventServices

EventServiceTiny · object[]

Show child attributes

payouts.events.eventServices.service

ServiceTiny · object

required

Show child attributes

payouts.events.eventServices.service.id

string

required

payouts.events.eventServices.service.duration

integer

required

payouts.events.eventServices.service.name

string

required

payouts.events.eventServices.service.color

string

required

payouts.events.eventServices.service.locationIds

string[] | null

payouts.events.eventServices.providerId

string | null

payouts.events.eventServices.bookables

EventServiceBookable · object[] | null

Show child attributes

payouts.events.eventServices.bookables.eventId

string

required

payouts.events.eventServices.bookables.serviceId

string

required

payouts.events.eventServices.bookables.bookableId

string

required

payouts.events.eventServices.bookables.start

string<date-time>

required

payouts.events.eventServices.bookables.end

string<date-time>

required

payouts.events.eventServices.start

string<date-time> | null

payouts.events.eventServices.end

string<date-time> | null

payouts.events.eventServices.externalId

string | null

payouts.events.eventServices.isArchived

boolean | null

payouts.events.icons

enum<string>[]

Available options:

BOOKING_FEE_PAID,

NEW_PATIENT,

SCHEDULED_BY_AI,

FORM_COMPLETED,

CHECKED_IN

payouts.events.capacity

integer | null

payouts.soldPackages

SoldPackage · object[]

required

Sold packages this payout is from

Show child attributes

payouts.soldPackages.packageId

string

required

Package ID that was sold

payouts.soldPackages.patientId

string

required

Patient ID who purchased the package

payouts.soldPackages.chargeItemId

string

required

Charge item ID associated with the package purchase

payouts.soldPackages.status

enum<string>

required

Status of the sold package

Available options:

USED,

ACTIVE,

CANCELLED

payouts.soldPackages.createdDate

string<date-time>

required

Date the package was created

payouts.soldPackages.id

string

Unique identifier for the sold package

payouts.soldPackages.package

Package · object

Details of the package

Show child attributes

payouts.soldPackages.package.name

string

required

Name of the package

payouts.soldPackages.package.price

integer

required

Price of the package in cents

payouts.soldPackages.package.id

string

Unique identifier for the package

payouts.soldPackages.package.description

string | null

Optional description of the package

payouts.soldPackages.package.isArchived

boolean

default:false

Whether the package is archived

payouts.soldPackages.package.internalNotes

string | null

Optional internal notes for the package

payouts.soldPackages.package.items

PackageItem · object[] | null

Items included in the package

Show child attributes

payouts.soldPackages.package.items.packageId

string

required

Package ID this item belongs to

payouts.soldPackages.package.items.itemId

string

required

Item ID for this package item

payouts.soldPackages.package.items.price

integer

required

Price of the item in the package in cents

payouts.soldPackages.package.items.id

string

Unique identifier for the package item

payouts.soldPackages.package.items.quantity

integer | null

Quantity of the item in the package

payouts.soldPackages.package.items.item

ItemTiny · object

Details of the item

Show child attributes

payouts.soldPackages.package.items.item.name

string

required

Name of the item

payouts.soldPackages.package.items.item.price

integer

required

Price of the item in cents

payouts.soldPackages.package.items.item.id

string

Unique identifier for the item

payouts.soldPackages.package.items.item.brandName

string | null

Optional brand name of the item

payouts.soldPackages.package.items.item.description

string | null

Optional description of the item

payouts.soldPackages.package.items.item.category

string | null

Category name (references category.name)

payouts.soldPackages.package.items.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

payouts.soldPackages.package.items.item.isPhysical

boolean

default:true

Whether the item is physical

payouts.soldPackages.package.items.item.isArchived

boolean

default:false

Whether the item is archived

payouts.soldPackages.package.items.item.internalNotes

string | null

Optional internal notes for the item

payouts.soldPackages.package.items.item.taxable

boolean

default:false

Whether the item is subject to taxes

payouts.soldPackages.package.items.item.sortOrder

integer | null

Optional sort order for the item

payouts.soldPackages.package.items.item.allowCustomPricing

boolean

default:false

Whether custom pricing is allowed for this item

payouts.soldPackages.package.items.item.type

enum<string>

default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:

ITEM,

PRODUCT,

MEDICATION,

SERVICE,

PACKAGE,

MEMBERSHIP

payouts.soldPackages.package.category

string | null

Category name (references category.name)

payouts.soldPackages.updatedDate

string<date-time> | null

Date the package was updated

payouts.id

string

Unique identifier for the commission payout

payouts.createdDate

string<date-time> | null

When the payout was created

totalPayout

integer

required

Total payout for this commission structure

commissionStructureId

string

required

Commission structure this report belongs to

creatorId

string

required

Creator of the report

string

required

Unique identifier for the commission report

createdDate

string<date-time> | null

When the report was created

updatedDate

string<date-time> | null

When the report was last updated

isArchived

boolean

default:false

Whether the report is archived

Get Banked Item Charge Items Get Commission Structure

⌘I

Getting Started

API

Tenant

Webhook

Get Commission Report

Headers

Path Parameters

Response