GET api/Commissions/GetEarningsByCommissionPeriod?repDID={repDID}&bonusRunID={bonusRunID}&localeID={localeID}&periodCalendar={periodCalendar}&period={period}

Returns the overall earnings and breakdown of earnings for a Rep per Bonus Run.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
repDID

The rep display identifier.

 string

Required
bonusRunID

Pass a specific Bonus Run ID if not using period to find bonus runs

 integer

None.
localeID

The locale identifier.

 integer

Default value is 1
periodCalendar

Values for this could be "Monthly", "Weekly" or any period calendars used by their compensation plan.

 string

Default value is Monthly
period

Values for this could be "Current" Or "Previous". Previous is limited to 50 Bonus Runs

 string

Default value is Current

Body Parameters

None.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/xml, text/xml, application/json, text/json

Sample:

Sample not available.