provider
inventory

Get Commissions For Provider

Get all commissions applicable to a provider through their commission groups

get/inventory/providers/{provider_id}/commissions

Request

Path parameters

provider_idstring required

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

idstring

Unique identifier for the commission

itemIdstring nullable

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

itemCategorystring nullable

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

itemIsPhysicalboolean nullable

Optional filter by whether item is physical

totalSalesAmountinteger nullable

Optional minimum total sales amount threshold in cents

commissionStructureIdstring required

Commission structure this commission belongs to

percentagenumber nullable

Commission percentage (0.0 to 1.0)

amountinteger nullable

Fixed commission amount in cents

deductCostboolean

Whether to deduct item cost before calculating commission (services only)

isArchivedboolean

Whether the commission is archived

updatedDatestring date-time nullable

When the commission was last updated

createdDatestring date-time nullable

When the commission was created

Changes

No recorded changes to this operation across all 2 revisions of this API.