Sign in
provider
inventory

Generate Commission Report

Generate commission payouts for one or more structures based on charges in the date range

post/inventory/commission-structures/generate-report

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

structure_idsstring[] required
start_datestring date required
end_datestring date required

Response

Successful Response

startDatestring date required

Start date of the report

endDatestring date required

End date of the report

totalPayoutinteger required

Total payout for this commission structure

commissionStructureIdstring required

Commission structure this report belongs to

creatorIdstring required

Creator of the report

idstring required

Unique identifier for the commission report

createdDatestring date-time nullable

When the report was created

updatedDatestring date-time nullable

When the report was last updated

isArchivedboolean

Whether the report is archived

Changes

No recorded changes to this endpoint across all 1 revision of this API.