The contract object

The contract object holds information for a contract. You can retrieve a contract’s object as well as list all contract objects.

Attributes

`Id` string

Unique identifier for the object referred to as the impact.com Contract Id.

`PartnerId` integer

Id of the partner signed to this contract.

`PartnerValue1` string

A value for a specific partner.

`Status` enum

Status of the contract.

View possible enum values
`ACTIVE`	Contract is currently active.
`EXPIRED`	Contract is no longer active.

`StartDate` datetime

Start date and time of the contract. See ISO-8601.

`EndDate` datetime

If Status=EXPIRED, the end date and time of the contract. See ISO-8601.

`BrandSignatory` string

Brand representative that agreed to the contract.

`BrandSignatoryDate` datetime

Date and time the brand representative agreed to the contract. See ISO-8601.

`PartnerSignatory` string

Partner representative that agreed to the contract.

`PartnerSignatoryDate` datetime

Date and time the partner representative agreed to the contract. See ISO-8601.

`DateCreated` datetime

Date and time the contract was created. See ISO-8601.

`DateLastUpdated` datetime

Date and time the contract was last updated. Will be empty of contract has not been updated. Contracts are immutable—any changes made to the contract aside from EndDate will generate a new contract. See ISO-8601.

`TemplateTerms` object

Template term information that the contract is based on.

View child attributes

`TemplateId` integer

Original template term’s Id.

`VersionId` integer

Template term’s version Id that was used for the contract.

`Name` string

Name of the original template terms.

`Labels` array

Labels associated with the original template terms.

`Currency` enum

Currency that the contract pays out in. See impact.com's supported currencies.

`EventPayouts` array

Payout details for the event type(s) used in the contract.

View child attributes

`EventTypeId` integer

Event type’s impact.com-assigned Id.

`EventTypeName` string

Name of the event type.

`EventCategory` enum

What type of event type is used in the contract.

View possible enum values
`LEAD`	Contract pays out for sale leads.
`SALE`	Contract pays out for online sales.
`DOWNLOAD`	Contract pays out for consumer downloads.
`PAGE_VISIT`	Contract pays out for traffic driven to a specific website.
`CALL_PER_RING`	Contract pays out for each phone call regardless of call outcome.
`CALL_PER_DURATION`	Contract pays out for total call time.
`CALL_PER_CONVERSATION`	Contract pays out for each call conversation.
`PARTNER_REFERRAL`	Contract pays out for partner referrals.
`DATA_POST`	Contract pays out for data posts that partners.
`OFFLINE`	Contract pays out for offline conversions.
`CLICK`	Contract pays out for clicks.
`MOBILE_APP`	Contract pays out for mobile app installs.

`DefaultPayout` decimal

If the contract's payout type is Fixed, this is the default payout amount. If present, DefaultPayoutRate will not be.

`DefaultPayoutRate` decimal

If the contract's payout type is Percent, this is the default percent of the sale that will become the payout. If present, DefaultPayout will not be.

`PayoutLevel` enum

The order level that the contract pays out at.

View possible enum values
`ITEM`	Payouts will be based on the items sold within an order.
`ORDER`	Payouts will be based on the order as a whole.
`CLICK`	Contract pays out for clicks.
`CALL`	Contract pays out for calls.

`PayoutGroups` array

Payout groups that the contract has set up.

View child attributes

`Id` string

Payout group’s Id.

`Rank` integer

Rank order of a payout group.

`Rules` array

Rules for how a specific payout group is triggered.

View child attributes

`Variable` enum

What the payout group looks for.

View possible enum values
`ITEM_SKU`	SKU number of the item.
`ITEM_SKU_LIST`	Array of item SKU numbers.
`ITEM_CATEGORY`	Category that the item is listed in.
`ITEM_CATEGORY_LIST`	Category list an item is placed in.
`ITEM_SUBCATEGORY`	Subcategory an item is placed in.
`ITEM_BRAND`	Brand that makes an item.
`ITEM_PRICE`	Price of an item.
`ITEM_QUANTITY`	Quantity of an item.
`ITEM_PROMO_CODE`	Promo code associated with an item.
`ITEM_PROMO_CODE_LIST`	Promo code list associated with an item.
`ITEM_DISCOUNT`	Item’s discount.
`ITEM_SUBTOTAL`	Item’s subtotal before any deals or fees are applied.
`ITEM_CATALOG_CATEGORY`	The catalog category an item was placed in.
`ITEM_CATALOG_ORIGINAL_FORMAT_CATEGORY`	The original catalog category an item was placed in.
`ITEM_CATALOG_SUBCATEGORY`	The catalog subcategory an item was placed in.
`ITEM_CATALOG_MANUFACTURER`	The item’s manufacturer as it is listed in a product catalog.
`ORDER_PROMO_CODE`	Promo code used in the order.
`ORDER_PROMO_CODE_LIST`	List a promo code used was placed in.
`ORDER_DISCOUNT`	Order’s discount.
`ORDER_SHIPPING`	Order’s shipping cost.
`ORDER_TAX`	Tax applied to an order.
`ORDER_PAYMENT_TYPE`	How a customer pays for an order.
`ORDER_LOCATION_ID`	The location Id an order was placed in.
`ORDER_LOCATION_NAME`	The location name an order was placed in.
`ORDER_LOCATION_TYPE`	The location type an order was placed in.
`ORDER_TOTAL`	The order total.
`GIFT_PURCHASE`	If the product purchased is intended to be a gift.
`CURRENCY`	The currency used to purchase the product.
`CUSTOMER_CITY`	The city a customer purchased the product from.
`CUSTOMER_REGION`	Region the customer purchased from.
`CUSTOMER_POSTCODE`	Postal code the customer purchased from.
`CUSTOMER_COUNTRY`	Country the customer purchased from.
`CUSTOMER_STATUS`	If the customer is new, existing, re-engaged, frequent, or another status.
`MONEY1`	A unique money value.
`MONEY2`	A unique money value.
`MONEY3`	A unique money value.
`DATE1`	A custom date value. See ISO 8601.
`DATE2`	A custom date value. See ISO 8601.
`DATE3`	A custom date value. See ISO 8601.
`NUMERIC1`	A custom numeric value.
`NUMERIC2`	A custom numeric value.
`NUMERIC3`	A custom numeric value.
`TEXT1`	A custom text value.
`TEXT2`	A custom text value.
`TEXT3`	A custom text value.
`SITE_CATEGORY`	The category a site was placed in.
`SITE_VERSION`	A website’s version.
`HEAR_ABOUT_US`	How a customer heard about the brand or product.
`NOTE`	A note.
`DERIVED_COUNTRY`	What country the payout group is derived from.
`DERIVED_STATE_REGION`	What state or region the payout group is derived from.
`DERIVED_DEVICE_TYPE`	What device type the payout group is derived from.
`DERIVED_BROWSER`	What browser the payout group is derived from.
`DERIVED_OS`	What operating system the payout group is derived from.
`REFERRAL_TYPE`	How the customer was referred to the product.
`REFERRAL_AD`	Ad associated with the referring action.
`REFERRAL_DEAL`	Deal associated with the referring action.
`REFERRAL_SHARED_ID`	SharedId associated with the referring action.
`REFERRAL_TRAFFIC_CATEGORY`	Traffic category associated with the referring action.
`REFERRAL_TRAFFIC_SOURCE`	Traffic source associated with the referring action.
`REFERRAL_SKU`	SKU code associated with the referring action.
`REFERRAL_URL`	URL associated with the referring action.
`REFERRAL_LANDING_PAGE`	Landing page associated with the referring action.
`REFERRAL_AD_PLACEMENT`	Ad placement associated with the referring action.
`REFERRAL_AD_TYPE`	Ad type associated with the referring action.
`REFERRAL_AD_KEYWORD`	Ad keyword associated with the referring action.
`REFERRAL_AD_CAMPAIGN`	Ad program (formerly known as campaign) associated with the referring action.
`REFERRAL_AD_CAMPAIGN_ID`	Ad program (formerly known as campaign) Id associated with the referring action.
`REFERRAL_AD_GROUP`	Ad group associated with the referring action.
`REFERRAL_AD_GROUP_ID`	Ad group Id associated with the referring action.
`REFERRAL_PARAM1`	Param parameter associated with the referring action.
`REFERRAL_PARAM2`	Param parameter associated with the referring action.
`REFERRAL_PARAM3`	Param parameter associated with the referring action.
`REFERRAL_PARAM4`	Param parameter associated with the referring action.
`REFERRAL_SUB_ACCOUNT_ID`	Sub account Id associated with the referring action.
`REFERRAL_SUB_ACCOUNT_NAME`	Sub account name associated with the referring action.
`REFERRAL_DERIVED_COUNTRY`	Payout group’s derived country associated with the referring action.
`REFERRAL_DERIVED_STATE_REGION`	Payout group’s derived state or region associated with the referring action.
`REFERRAL_DERIVED_DEVICE_TYPE`	Payout group’s derived device type associated with the referring action.
`REFERRAL_DERIVED_BROWSER`	Payout group’s derived web browser associated with the referring action.
`REFERRAL_DERIVED_OS`	Payout group’s derived operating system associated with the referring action.
`CALLER_COUNTRY`	Country the caller called from.
`CALLED_COUNTRY`	Country of the call recipient.
`CALLED_NUMBER`	Phone number of the call recipient.
`CALL_DURATION`	Duration of the phone call.
`CALL_TALK_DURATION`	Duration of the phone conversation.
`CALL_PHONE_TYPE`	Type of phone the call recipient used.
`CALL_KEY1`	A custom call key.
`CALL_KEY2`	A custom call key.
`CALL_KEY3`	A custom call key.
`CALL_KEY4`	A custom call key.
`CALL_TRAFFIC_SOURCE`	Traffic source associated with the phone call.
`PATH_PARTICIPATION_CHANNELS`	What channels were involved in a customer’s journey.
`PATH_PARTICIPATING_MEDIA`	What partner(s) were involved in a customer’s journey.
`PATH_PARTICIPATING_GROUPS`	What partner groups were involved in a customer’s journey.
`PATH_STEPS`	Amount of steps a customer took on their journey.
`PATH_INTRODUCING_MEDIA`	Partner(s) that started a customer’s journey.
`PATH_INTRODUCING_GROUPS`	Comma-separated list of the partner group(s) that began a customer’s journey.
`PATH_INTRODUCING_CHANNELS`	Comma-separated list of the channel(s) that began a customer’s journey.
`PATH_CLOSING_MEDIA`	Partner that closed a customer journey.
`PATH_CLOSING_GROUPS`	Comma-separated list of the partner group(s) that closed the sale.
`PATH_CLOSING_CHANNELS`	Comma-separated list of channels that closed the sale.
`PATH_MEDIA_COUNT`	How many media pieces were involved in the customer’s journey.
`PATH_IMPACT_PARTNER_COUNT`	How many partners were involved in the customer’s journey.
`PATH_PARTNER_COUNT`	How many partners were involved in a customer’s journey.
`PATH_CHANNEL_COUNT`	How many steps the customer took on their purchase journey.

`Operator` enum

How the Variable is applied.

View possible enum values
`IS`	`Variable` must be `Value`.
`IS_NOT`	`Variable` cannot be `Value`.
`IS_NOT_WHEN_PRESENT`	If `Variable` is present, it cannot be `Value`. Only for string `Values`.
`IS_PRESENT`	If `Variable` is present.
`IS_NOT_PRESENT`	If `Variable` is not present.
`RANGE`	Number range that `Value` can land in. Only for integer `Values`.
`LESS_THAN`	`Variable` must be lower than `Value`. Only for integer `Values`.
`GREATER_THAN`	`Variable` must be greater than `Value`. Only for integer `Values`.
`DATE_RANGE`	`Variable` must land within the date range defined in `Value`.
`DATE_LESS_THAN`	`Variable` must be before the date defined in `Value`.
`DATE_GREATER_THAN`	`Variable`Value.
`WILDCARD`	If the listed character string(s) appear anywhere in `Value`. Only for string `Values`.
`BEGINS_WITH`	If `Value` begins with certain characters. Only for string `Values`.
`ENDS_WITH`	If `Value` ends with certain characters. Only for string `Values`.
`CONTAINS`	If `Value` contains certain characters. Only for string `Values`.
`DOES_NOT_CONTAIN`	If `Value` does not contain certain characters. Only for string `Values`.
`COLLECTION_CONTAINS`	If `Value` is contained within the collection.
`COLLECTION_DOES_NOT_CONTAIN`	If `Value` is not contained in the collection.

`Values` array

What Variable is looking for. Will be empty if Variable: IS_PRESENT or Variable: IS_NOT_PRESENT.

`Payout` decimal

The payout amount if the payout rule is applied. If present, PayoutRate will not be.

`PayoutRate` integer

Order percentage that will become the payout if the tier is met. If present, Payout will not be.

`Limits` array

Rules that limit the payout group applying to an action.

View child attributes

`Type` enum

How the limit is applied.

View possible enum values
`CLICKS`	Click count will be limited.
`ITEM`	Item count will be limited.
`PAYOUT`	An action’s payout will be limited.
`ACTION`	Amount of actions payable will be limited.
`CONCURRENT_CALLS`	Number of concurrent call will be limited.

`Subtype` enum

Any additional scope on what the limit rules look for.

View possible enum values
`SKU`	An item's SKU number.
`CATEGORY`	Category an item is placed in.
`TEXT2`	A custom text value.

`Value` decimal

If Type="PAYOUT", then the payout maximum. If Type="ACTIONS", then the maximum amount of payable actions.

`LimitBy` enum

What level Value is applied to.

View possible enum values
`ITEM`	`LimitBy` is applied to each item.
`ORDER`	`LimitBy` is applied to the entire order.
`CUSTOMER`	`LimitBy` is applied to each customer.
`CLICK`	`LimitBy` is applied to each click.
`CALLER_ID`	`LimitBy` is applied to each caller Id.

`Period` enum

How often the limit resets. If LimitBy="CLICK", will not appear.

View possible enum values
`DAY`	Payout limit resets daily.
`WEEK`	Payout limit resets weekly.
`MONTH`	Payout limit resets monthly.
`QUARTER`	Payout limit resets quarterly.
`CONTRACT_DURATION`	Limit lasts the duration of the contract.

`WeekendOverrideValue` integer

What the limit becomes during the weekends.

`Tiers` array

Payout tiers of the payout group. These tiers will apply based on the performance of the component items or variables within the rule. As partners drive more traffic, events, or conversions, they can reach higher payout tiers (which would change their payouts or payout rates).

View child attributes

`RevenueThreshold` decimal

Minimum revenue needed for the next payout group tier to initiate. If used, neither ActionThreshold nor ParentTier will appear for this payout group.

`ActionThreshold` integer

Minimum number of actions needed for the next payout group tier to initiate. If used, neither RevenueThreshold nor ParentTier will appear for this payout group.

`ParentTier` integer

Minimum number of actions needed for all payout groups to collectively advance to their next respective tier. All payout groups contribute to the same ParentTier. If used, neither RevenueThreshold nor ActionThreshold will appear for this payout group.

`Payout` decimal

The payout amount if the tier is met. If present, PayoutRate will not be.

`PayoutRate` decimal

Order percentage that will become the payout if the tier is met. If present, Payout will not be.

`PayoutAdjustments` array

Conditions that can change an action’s payout details.

View child attributes

`Id` string

Payout adjustment’s Id.

`Rules` array

Rules for how the payout adjustment applies.

View child attributes

`Variable` enum

What the payout group looks for.

View possible enum values
`ITEM_SKU`	SKU number of the item.
`ITEM_SKU_LIST`	Array of item SKU numbers.
`ITEM_CATEGORY`	Category that the item is listed in.
`ITEM_CATEGORY_LIST`	Category list an item is placed in.
`ITEM_SUBCATEGORY`	Subcategory an item is placed in.
`ITEM_BRAND`	Brand that makes an item.
`ITEM_PRICE`	Price of an item.
`ITEM_QUANTITY`	Quantity of an item.
`ITEM_PROMO_CODE`	Promo code associated with an item.
`ITEM_PROMO_CODE_LIST`	Promo code list associated with an item.
`ITEM_DISCOUNT`	Item’s discount.
`ITEM_SUBTOTAL`	Item’s subtotal before any deals or fees are applied.
`ITEM_CATALOG_CATEGORY`	The catalog category an item was placed in.
`ITEM_CATALOG_ORIGINAL_FORMAT_CATEGORY`	The original catalog category an item was placed in.
`ITEM_CATALOG_SUBCATEGORY`	The catalog subcategory an item was placed in.
`ITEM_CATALOG_MANUFACTURER`	The item’s manufacturer as it is listed in a product catalog.
`ORDER_PROMO_CODE`	Promo code used in the order.
`ORDER_PROMO_CODE_LIST`	List a promo code used was placed in.
`ORDER_DISCOUNT`	Order’s discount.
`ORDER_SHIPPING`	Order’s shipping cost.
`ORDER_TAX`	Tax applied to an order.
`ORDER_PAYMENT_TYPE`	How a customer pays for an order.
`ORDER_LOCATION_ID`	The location Id an order was placed in.
`ORDER_LOCATION_NAME`	The location name an order was placed in.
`ORDER_LOCATION_TYPE`	The location type an order was placed in.
`ORDER_TOTAL`	The order total.
`GIFT_PURCHASE`	If the product purchased is intended to be a gift.
`CURRENCY`	The currency used to purchase the product.
`CUSTOMER_CITY`	The city a customer purchased the product from.
`CUSTOMER_REGION`	Region the customer purchased from.
`CUSTOMER_POSTCODE`	Postal code the customer purchased from.
`CUSTOMER_COUNTRY`	Country the customer purchased from.
`CUSTOMER_STATUS`	If the customer is new, existing, re-engaged, frequent, or another status.
`MONEY1`	A unique money value.
`MONEY2`	A unique money value.
`MONEY3`	A unique money value.
`DATE1`	A custom date value. See ISO 8601.
`DATE2`	A custom date value. See ISO 8601.
`DATE3`	A custom date value. See ISO 8601.
`NUMERIC1`	A custom numeric value.
`NUMERIC2`	A custom numeric value.
`NUMERIC3`	A custom numeric value.
`TEXT1`	A custom text value.
`TEXT2`	A custom text value.
`TEXT3`	A custom text value.
`SITE_CATEGORY`	The category a site was placed in.
`SITE_VERSION`	A website’s version.
`HEAR_ABOUT_US`	How a customer heard about the brand or product.
`NOTE`	A note.
`DERIVED_COUNTRY`	What country the payout adjustment is derived from.
`DERIVED_STATE_REGION`	What state or region the payout adjustment is derived from.
`DERIVED_DEVICE_TYPE`	What device type the payout adjustment is derived from.
`DERIVED_BROWSER`	What browser the payout adjustment is derived from.
`DERIVED_OS`	What operating system the payout adjustment is derived from.
`REFERRAL_TYPE`	How the customer was referred to the product.
`REFERRAL_AD`	Ad associated with the referring action.
`REFERRAL_DEAL`	Deal associated with the referring action.
`REFERRAL_SHARED_ID`	SharedId associated with the referring action.
`REFERRAL_TRAFFIC_CATEGORY`	Traffic category associated with the referring action.
`REFERRAL_TRAFFIC_SOURCE`	Traffic source associated with the referring action.
`REFERRAL_SKU`	SKU code associated with the referring action.
`REFERRAL_URL`	URL associated with the referring action.
`REFERRAL_LANDING_PAGE`	Landing page associated with the referring action.
`REFERRAL_AD_PLACEMENT`	Ad placement associated with the referring action.
`REFERRAL_AD_TYPE`	Ad type associated with the referring action.
`REFERRAL_AD_KEYWORD`	Ad keyword associated with the referring action.
`REFERRAL_AD_CAMPAIGN`	Ad program (formerly known as campaign) associated with the referring action.
`REFERRAL_AD_CAMPAIGN_ID`	Ad program (formerly known as campaign) Id associated with the referring action.
`REFERRAL_AD_GROUP`	Ad group associated with the referring action.
`REFERRAL_AD_GROUP_ID`	Ad group Id associated with the referring action.
`REFERRAL_PARAM1`	Param parameter associated with the referring action.
`REFERRAL_PARAM2`	Param parameter associated with the referring action.
`REFERRAL_PARAM3`	Param parameter associated with the referring action.
`REFERRAL_PARAM4`	Param parameter associated with the referring action.
`REFERRAL_SUB_ACCOUNT_ID`	Sub account Id associated with the referring action.
`REFERRAL_SUB_ACCOUNT_NAME`	Sub account name associated with the referring action.
`REFERRAL_DERIVED_COUNTRY`	Payout adjustment's derived country associated with the referring action.
`REFERRAL_DERIVED_STATE_REGION`	Payout adjustment's derived state or region associated with the referring action.
`REFERRAL_DERIVED_DEVICE_TYPE`	Payout adjustment's derived device type associated with the referring action.
`REFERRAL_DERIVED_BROWSER`	Payout adjustment's derived web browser associated with the referring action.
`REFERRAL_DERIVED_OS`	Payout adjustment's derived operating system associated with the referring action.
`CALLER_COUNTRY`	Country the caller called from.
`CALLED_COUNTRY`	Country of the call recipient.
`CALLED_NUMBER`	Phone number of the call recipient.
`CALL_DURATION`	Duration of the phone call.
`CALL_TALK_DURATION`	Duration of the phone conversation.
`CALL_PHONE_TYPE`	Type of phone the call recipient used.
`CALL_KEY1`	A custom call key.
`CALL_KEY2`	A custom call key.
`CALL_KEY3`	A custom call key.
`CALL_KEY4`	A custom call key.
`CALL_TRAFFIC_SOURCE`	Traffic source associated with the phone call.
`PATH_PARTICIPATION_CHANNELS`	What channels were involved in a customer’s journey.
`PATH_PARTICIPATING_MEDIA`	What partner(s) were involved in a customer’s journey.
`PATH_PARTICIPATING_GROUPS`	What partner groups were involved in a customer’s journey.
`PATH_STEPS`	Amount of steps a customer took on their journey.
`PATH_INTRODUCING_MEDIA`	Partner(s) that started a customer’s journey.
`PATH_INTRODUCING_GROUPS`	Comma-separated list of the partner group(s) that began a customer’s journey.
`PATH_INTRODUCING_CHANNELS`	Comma-separated list of the channel(s) that began a customer’s journey.
`PATH_CLOSING_MEDIA`	Partner that closed a customer journey.
`PATH_CLOSING_GROUPS`	Comma-separated list of the partner group(s) that closed the sale.
`PATH_CLOSING_CHANNELS`	Comma-separated list of channels that closed the sale.
`PATH_MEDIA_COUNT`	How many media pieces were involved in the customer’s journey.
`PATH_IMPACT_PARTNER_COUNT`	How many partners were involved in the customer’s journey.
`PATH_PARTNER_COUNT`	How many partners were involved in a customer’s journey.
`PATH_CHANNEL_COUNT`	How many steps the customer took on their purchase journey.

`Operator` enum

How the Variable is applied.

View possible enum values
`IS`	`Variable` must be `Value`.
`IS_NOT`	`Variable` cannot be `Value`.
`IS_NOT_WHEN_PRESENT`	If `Variable` is present, it cannot be `Value`. Only for string `Values`.
`IS_PRESENT`	If `Variable` is present.
`IS_NOT_PRESENT`	If `Variable` is not present.
`RANGE`	Number range that `Value` can land in. Only for integer `Values`.
`LESS_THAN`	`Variable` must be lower than `Value`. Only for integer `Values`.
`GREATER_THAN`	`Variable` must be greater than `Value`. Only for integer `Values`.
`DATE_RANGE`	`Variable` must land within the date range defined in `Value`.
`DATE_LESS_THAN`	`Variable` must be before the date defined in `Value`.
`DATE_GREATER_THAN`	`Variable`Value.
`WILDCARD`	If the listed character string(s) appear anywhere in `Value`. Only for string `Values`.
`BEGINS_WITH`	If `Value` begins with certain characters. Only for string `Values`.
`ENDS_WITH`	If `Value` ends with certain characters. Only for string `Values`.
`CONTAINS`	If `Value` contains certain characters. Only for string `Values`.
`DOES_NOT_CONTAIN`	If `Value` does not contain certain characters. Only for string `Values`.
`COLLECTION_CONTAINS`	If `Value` is contained within the collection.
`COLLECTION_DOES_NOT_CONTAIN`	If `Value` is not contained in the collection.

`Values` array

What Variable is looking for. Will be empty if Variable: IS_PRESENT or Variable: IS_NOT_PRESENT.

`Direction` enum

How the payout is adjusted.

View possible enum values
`INCREASE`	Raise the payout by a certain percentage.
`DECREASE`	Lower the payout by a certain percentage.
`ADD`	Add a fixed amount to the payout.
`SUBTRACT`	Remove a fixed amount from the payout.

`Amount` decimal

If Direction: "ADD || SUBTRACT", then the fixed amount change will appear.

`Rate` integer

If Direction: "INCREASE || DECREASE", then the percent change will appear.

`PerformanceBonus` array

Additional payments to partners if they drive enough actions.

View child attributes

`Type` enum

To which actions a performance will be based on.

View possible enum values
`ALL_ACTIONS`	Bonus is based on all actions driven.
`SUBSEQUENT_ACTIONS`	Bonus is based on all actions after a certain goal is hit.
`FIXED`	Bonus is a fixed amount.

`Basis` enum

What the bonus is based on. Defaults to REVENUE.

View possible enum values
`REVENUE`	Bonus is based on revenue brought in.
`ACTIONS`	Bonus is based on total actions.

`Period` enum

How often a bonus can be granted. Will always be CALENDAR_MONTH.

`BonusTiers` array

Tiering system for the bonus.

View child attributes

`RevenueThreshold` decimal

Minimum revenue needed for the next bonus tier to initiate. If used, `ActionThreshold` will not appear for this payout group.

`ActionThreshold` integer

Minimum number of actions needed for the next bonus tier to initiate. If used, `RevenueThreshold` will not appear for this payout group.

`Payout` decimal

The payout amount if the tier is met. If present, PayoutRate will not be.

`PayoutRate` decimal

Order percentage that will become the payout if the tier is met. If present, Payout will not be.

`PayoutRestrictions` array

Customer order conditions that can prevent a partner from getting paid out.

View child attributes

`Id` string

Id for a specific payout restriction.

`Rules` array

How a payout restriction is applied.

View child attributes

`Variable` enum

What the payout group looks for.

View possible enum values
`ITEM_SKU`	SKU number of the item.
`ITEM_SKU_LIST`	Array of item SKU numbers.
`ITEM_CATEGORY`	Category that the item is listed in.
`ITEM_CATEGORY_LIST`	Category list an item is placed in.
`ITEM_SUBCATEGORY`	Subcategory an item is placed in.
`ITEM_BRAND`	Brand that makes an item.
`ITEM_PRICE`	Price of an item.
`ITEM_QUANTITY`	Quantity of an item.
`ITEM_PROMO_CODE`	Promo code associated with an item.
`ITEM_PROMO_CODE_LIST`	Promo code list associated with an item.
`ITEM_DISCOUNT`	Item’s discount.
`ITEM_SUBTOTAL`	Item’s subtotal before any deals or fees are applied.
`ITEM_CATALOG_CATEGORY`	The catalog category an item was placed in.
`ITEM_CATALOG_ORIGINAL_FORMAT_CATEGORY`	The original catalog category an item was placed in.
`ITEM_CATALOG_SUBCATEGORY`	The catalog subcategory an item was placed in.
`ITEM_CATALOG_MANUFACTURER`	The item’s manufacturer as it is listed in a product catalog.
`ORDER_PROMO_CODE`	Promo code used in the order.
`ORDER_PROMO_CODE_LIST`	List a promo code used was placed in.
`ORDER_DISCOUNT`	Order’s discount.
`ORDER_SHIPPING`	Order’s shipping cost.
`ORDER_TAX`	Tax applied to an order.
`ORDER_PAYMENT_TYPE`	How a customer pays for an order.
`ORDER_LOCATION_ID`	The location Id an order was placed in.
`ORDER_LOCATION_NAME`	The location name an order was placed in.
`ORDER_LOCATION_TYPE`	The location type an order was placed in.
`ORDER_TOTAL`	The order total.
`GIFT_PURCHASE`	If the product purchased is intended to be a gift.
`CURRENCY`	The currency used to purchase the product.
`CUSTOMER_CITY`	The city a customer purchased the product from.
`CUSTOMER_REGION`	Region the customer purchased from.
`CUSTOMER_POSTCODE`	Postal code the customer purchased from.
`CUSTOMER_COUNTRY`	Country the customer purchased from.
`CUSTOMER_STATUS`	If the customer is new, existing, re-engaged, frequent, or another status.
`MONEY1`	A unique money value.
`MONEY2`	A unique money value.
`MONEY3`	A unique money value.
`DATE1`	A custom date value. See ISO 8601.
`DATE2`	A custom date value. See ISO 8601.
`DATE3`	A custom date value. See ISO 8601.
`NUMERIC1`	A custom numeric value.
`NUMERIC2`	A custom numeric value.
`NUMERIC3`	A custom numeric value.
`TEXT1`	A custom text value.
`TEXT2`	A custom text value.
`TEXT3`	A custom text value.
`SITE_CATEGORY`	The category a site was placed in.
`SITE_VERSION`	A website’s version.
`HEAR_ABOUT_US`	How a customer heard about the brand or product.
`NOTE`	A note.
`DERIVED_COUNTRY`	What country the payout group is derived from.
`DERIVED_STATE_REGION`	What state or region the payout group is derived from.
`DERIVED_DEVICE_TYPE`	What device type the payout group is derived from.
`DERIVED_BROWSER`	What browser the payout group is derived from.
`DERIVED_OS`	What operating system the payout group is derived from.
`REFERRAL_TYPE`	How the customer was referred to the product.
`REFERRAL_AD`	Ad associated with the referring action.
`REFERRAL_DEAL`	Deal associated with the referring action.
`REFERRAL_SHARED_ID`	SharedId associated with the referring action.
`REFERRAL_TRAFFIC_CATEGORY`	Traffic category associated with the referring action.
`REFERRAL_TRAFFIC_SOURCE`	Traffic source associated with the referring action.
`REFERRAL_SKU`	SKU code associated with the referring action.
`REFERRAL_URL`	URL associated with the referring action.
`REFERRAL_LANDING_PAGE`	Landing page associated with the referring action.
`REFERRAL_AD_PLACEMENT`	Ad placement associated with the referring action.
`REFERRAL_AD_TYPE`	Ad type associated with the referring action.
`REFERRAL_AD_KEYWORD`	Ad keyword associated with the referring action.
`REFERRAL_AD_CAMPAIGN`	Ad program (formerly known as campaign) associated with the referring action.
`REFERRAL_AD_CAMPAIGN_ID`	Ad program (formerly known as campaign) Id associated with the referring action.
`REFERRAL_AD_GROUP`	Ad group associated with the referring action.
`REFERRAL_AD_GROUP_ID`	Ad group Id associated with the referring action.
`REFERRAL_PARAM1`	Param parameter associated with the referring action.
`REFERRAL_PARAM2`	Param parameter associated with the referring action.
`REFERRAL_PARAM3`	Param parameter associated with the referring action.
`REFERRAL_PARAM4`	Param parameter associated with the referring action.
`REFERRAL_SUB_ACCOUNT_ID`	Sub account Id associated with the referring action.
`REFERRAL_SUB_ACCOUNT_NAME`	Sub account name associated with the referring action.
`REFERRAL_DERIVED_COUNTRY`	Payout restriction's derived country associated with the referring action.
`REFERRAL_DERIVED_STATE_REGION`	Payout restriction's derived state or region associated with the referring action.
`REFERRAL_DERIVED_DEVICE_TYPE`	Payout restriction's derived device type associated with the referring action.
`REFERRAL_DERIVED_BROWSER`	Payout restriction's derived web browser associated with the referring action.
`REFERRAL_DERIVED_OS`	Payout restriction's derived operating system associated with the referring action.
`CALLER_COUNTRY`	Country the caller called from.
`CALLED_COUNTRY`	Country of the call recipient.
`CALLED_NUMBER`	Phone number of the call recipient.
`CALL_DURATION`	Duration of the phone call.
`CALL_TALK_DURATION`	Duration of the phone conversation.
`CALL_PHONE_TYPE`	Type of phone the call recipient used.
`CALL_KEY1`	A custom call key.
`CALL_KEY2`	A custom call key.
`CALL_KEY3`	A custom call key.
`CALL_KEY4`	A custom call key.
`CALL_TRAFFIC_SOURCE`	Traffic source associated with the phone call.
`PATH_PARTICIPATION_CHANNELS`	What channels were involved in a customer’s journey.
`PATH_PARTICIPATING_MEDIA`	What partner(s) were involved in a customer’s journey.
`PATH_PARTICIPATING_GROUPS`	What partner groups were involved in a customer’s journey.
`PATH_STEPS`	Amount of steps a customer took on their journey.
`PATH_INTRODUCING_MEDIA`	Partner(s) that started a customer’s journey.
`PATH_INTRODUCING_GROUPS`	Comma-separated list of the partner group(s) that began a customer’s journey.
`PATH_INTRODUCING_CHANNELS`	Comma-separated list of the channel(s) that began a customer’s journey.
`PATH_CLOSING_MEDIA`	Partner that closed a customer journey.
`PATH_CLOSING_GROUPS`	Comma-separated list of the partner group(s) that closed the sale.
`PATH_CLOSING_CHANNELS`	Comma-separated list of channels that closed the sale.
`PATH_MEDIA_COUNT`	How many media pieces were involved in the customer’s journey.
`PATH_IMPACT_PARTNER_COUNT`	How many partners were involved in the customer’s journey.
`PATH_PARTNER_COUNT`	How many partners were involved in a customer’s journey.
`PATH_CHANNEL_COUNT`	How many steps the customer took on their purchase journey.

`Operator` enum

How the Variable is applied.

View possible enum values
`IS`	`Variable` must be `Value`.
`IS_NOT`	`Variable` cannot be `Value`.
`IS_NOT_WHEN_PRESENT`	If `Variable` is present, it cannot be `Value`. Only for string `Values`.
`IS_PRESENT`	If `Variable` is present.
`IS_NOT_PRESENT`	If `Variable` is not present.
`RANGE`	Number range that `Value` can land in. Only for integer `Values`.
`LESS_THAN`	`Variable` must be lower than `Value`. Only for integer `Values`.
`GREATER_THAN`	`Variable` must be greater than `Value`. Only for integer `Values`.
`DATE_RANGE`	`Variable` must land within the date range defined in `Value`.
`DATE_LESS_THAN`	`Variable` must be before the date defined in `Value`.
`DATE_GREATER_THAN`	`Variable`Value.
`WILDCARD`	If the listed character string(s) appear anywhere in `Value`. Only for string `Values`.
`BEGINS_WITH`	If `Value` begins with certain characters. Only for string `Values`.
`ENDS_WITH`	If `Value` ends with certain characters. Only for string `Values`.
`CONTAINS`	If `Value` contains certain characters. Only for string `Values`.
`DOES_NOT_CONTAIN`	If `Value` does not contain certain characters. Only for string `Values`.
`COLLECTION_CONTAINS`	If `Value` is contained within the collection.
`COLLECTION_DOES_NOT_CONTAIN`	If `Value` is not contained in the collection.

`Values` array

What Variable is looking for. Will be empty if Variable: IS_PRESENT or Variable: IS_NOT_PRESENT.

`Limits` array

Rules on how a payout can be limited.

View child attributes

`Type` enum

How the limit is applied.

View possible enum values
`CLICKS`	Click count will be limited.
`ITEM`	Item count will be limited.
`PAYOUT`	An action’s payout will be limited.
`ACTION`	Amount of actions payable will be limited.
`CONCURRENT_CALLS`	Number of concurrent call will be limited.

`Subtype` enum

Any additional scope on what the limit rules look for.

View possible enum values
`SKU`	An item's SKU number.
`CATEGORY`	Category an item is placed in.
`TEXT2`	A custom text value.

`Value` decimal

If Type="PAYOUT", then the payout maximum. If Type="ACTIONS", then the maximum amount of payable actions.

`LimitBy` enum

What level Value is applied to.

View possible enum values
`ITEM`	`LimitBy` is applied to each item.
`ORDER`	`LimitBy` is applied to the entire order.
`CUSTOMER`	`LimitBy` is applied to each customer.
`CLICK`	`LimitBy` is applied to each click.
`CALLER_ID`	`LimitBy` is applied to each caller Id.

`Period` enum

How often the limit resets. If LimitBy="CLICK", will not appear.

View possible enum values
`DAY`	Payout limit resets daily.
`WEEK`	Payout limit resets weekly.
`MONTH`	Payout limit resets monthly.
`QUARTER`	Payout limit resets quarterly.
`CONTRACT_DURATION`	Limit lasts the duration of the contract.

`WeekendOverrideValue` integer

What the limit becomes during the weekends.

`Locking` array

Action locking rules for the contract.

View child attributes

`Basis` enum

When the action locking period begins. Defaults to TRACKED.

View possible enum values
`TRACKED`	When the action is initially tracked by or reported to impact.com.
`APPROVED`	When the action has been approved by an account user.
`COMMISSIONABLE`	When the action is eligible for commission.

`Period` enum

If there is a delay between the action Basis occurring and the action locking period beginning. Defaults to MONTH.

View possible enum values
`DAY`	`Period` is measured in days.
`WEEK`	`Period` is measured in weeks.
`HALF_MONTH`	`Period` is measured in half-months.
`MONTH`	`Period` is measured in months.

`MonthOffset` integer

How many months the action locking period will last. Defaults to 1.

`DayOffset` integer

How many days after the last offset month the action locking period will last. Defaults to 0.

`DayOfMonth` integer

The day of the month after MonthOffset. Defaults to not visible in the Contracts object.

`OpenEndedAutoLockingMode` enum

What happens to an action at the end of the Open-ended locking period.

View possible enum values
`APPROVE`	Actions are defaulted to approved.
`REJECT`	Actions are defaulted to rejected.

`MaxMonthsOpenEndedPeriod` integer

How many months an action can stay in open-ended locking.

`PayoutScheduling` array

Payout scheduling rules for the contract.

View child attributes

`Basis` enum

When the payout scheduling period begins. Defaults to LOCKED.

View possible enum values
`LOCKED`	When the action has completed the action locking period.
`INVOICED`	When the action has been added to an invoice.

`Period` enum

If there is a delay between the action Basis occurring and the payout scheduling period beginning.

View possible enum values
`END_OF_DAY`	Payout scheduling period will begin at the end of the day the `Basis` event happens.
`END_OF_MONTH`	Payout scheduling period will begin at the end of the month the `Basis` event happens.

`MonthOffset` integer

How many months the payout scheduling period will last. Defaults to 1.

`DayOffset` integer

How many days after the last offset month the payout scheduling period will last. Defaults to 0.

`LocationRequirementType` enum

What countries must/must not be included in the contract.

View possible enum values
`INCLUDE`	Listed countries must be included in potential consumer country list.
`EXCLUDE`	Listed countries must be excluded from potential consumer country list.

`LocationRequirementCountries` string

List of countries that must be included in/excluded from the potential consumer country list.

`CreditPolicy` enum

How the contract pays out for actions driven.

View possible enum values
`LAST_REFERRER`	Last partner to refer the customer gets the sale.
`FIRST_REFERRER`	First partner to refer the customer gets the sale.
`LAST_TO_CART`	Last partner to get the consumer to add to their cart gets the sale.
`FIRST_TO_CART`	First partner to get the consumer to add to their cart gets the sale.
`PARENT_ACTION`	Whoever drove the parent action gets the sale.

`ValidReferrals` array

How the contract decides which partner(s) gets credited.

View child attributes

`Type` enum

Action the contract looks at to decide who gets credited.

View possible enum values
`PARENT_ACTIONS`	Contract looks at parent actions.
`CLICKS`	Contract looks at clicks.
`IMPRESSIONS`	Contract looks at impressions.

`Window` integer

Maximum time that a partner can still be credited for driving an action if they drove a customer to make that action.

`WindowUnit` enum

The unit of time for Window.

View possible enum values
`HOUR`
`DAY`

`SpecialTermsList` array

Any custom terms for the contract.

View child attributes

`TermsName` string

Custom terms name.

`TermsType` enum

Type of custom terms.

View possible enum values
`CUSTOM`	General custom terms.
`EMAIL`	Custom terms apply to any emailing.
`COPYWRITING`	Custom terms apply to all copywriting.
`PAID_SEARCH`	Custom terms apply to any paid search efforts.
`EMAIL`	Custom terms apply SEO efforts.
`TRADEMARK`	Custom terms apply to trademarked terms.
`APPROVAL`	Custom terms are in regards to the approval process a partner must adhere to.

`TermsContent` string

All of the custom terms.

`TermsPdfUri` string

The contract’s custom terms' direct URI to download a PDF copy.

`ChangeNotificationPeriod` integer

The minimum notification time a partner gets to have if the contract terms change.

`ReturnPolicy` enum

How much of an action payout recoverable if a customer makes a return.

View possible enum values
`ALWAYS_OK`	Payouts on returned orders are always recoverable up to the percentage in `MaxReturnPercentage`.
`MP_APPROVAL_REQ`	Partner approves requested payout returns.
`NO_RETURNS`	Partners never need to return payouts for driven actions.

`MaxReturnPercentage` decimal

Maximum percentage of payouts returnable per month in the case of customer-returned orders.

`ActionLimit` integer

How many actions a partner can be paid out for in a given time period decided in ActionLimitPeriod.

`ActionLimitPeriod` enum

How often the ActionLimit refreshes.

View possible enum values
`DAY`	Action limit resets daily.
`WEEK`	Action limit resets weekly.
`MONTH`	Action limit resets monthly.
`QUARTER`	Action limit resets quarterly.
`IO_DURATION`	Limit lasts the duration of the contract.

`SpendLimit` decimal

Maximum payout to a given partner in a given time period decided in SpendLimitPeriod.

`SpendLimitPeriod` enum

How often the SpendLimit refreshes.

View possible enum values
`DAY`	Spend limit resets daily.
`WEEK`	Spend limit resets weekly.
`MONTH`	Spend limit resets monthly.
`QUARTER`	Spend limit resets quarterly.
`IO_DURATION`	Limit lasts the duration of the contract.

`MinEarningPerClick` decimal

Partner’s guaranteed earnings for driving a click.

`ContractStartSlottingFee` decimal

Payment to a partner to begin the contract.

`FirstActionSlottingFee` decimal

Payment to a partner after they drive their first action.

`MonthlySlottingFee` decimal

Monthly payment to a partner.

`CustomCreativePayer` enum

Who pays for or creates ad creative. Defaults to ADVERTISER.

View possible enum values
`ADVERTISER`	Brand (formerly known as advertiser) pays for ad creative creation.
`PUBLISHER`	Partner (formerly known as publisher) pays for ad creative creation.
`NOT_APPLICABLE`	Ad creative creation payments are not applicable to the contract.

`PdfUri` string

The contract’s direct URI to download a PDF copy of the contract.

`Uri` string

The contract’s direct URI to view only that contract.

{
  "Id": "S-7777777",
  "PartnerId": "10000",
  "PartnerValue1": "",
  "Status": "ACTIVE",
  "StartDate": "2021-01-20T00:00:00-08:00",
  "EndDate": "",
  "BrandSignatory": "Brand Man",
  "BrandSignatoryDate": "2021-01-19T23:51:01-08:00",
  "PartnerSignatory": "Partner Person",
  "PartnerSignatoryDate": "2021-01-19T23:51:01-08:00",
  "DateCreated": "2021-01-19T23:51:01-08:00",
  "DateLastUpdated": "2021-01-19T23:51:01-08:00",
  "TemplateTerms": {
    "TemplateId": "99999",
    "VersionId": "000006",
    "Name": "ACME Public Terms",
    "Labels": [
      "HighestPercent"
      ],
    "Currency": "USD",
    "EventPayouts": [
      {
        "EventTypeId": "18500",
        "EventTypeName": "Online Sale",
        "EventCategory": "SALE",
        "DefaultPayoutRate": "15",
        "PayoutLevel": "ITEM",
        "PayoutGroups": [
          {
            "Id": "ab12c3d4-5e6f-7g89-01h2-345ijk6lmn78",
            "Rank": "1",
            "Rules": [
              {
                "Variable": "CUSTOMER_COUNTRY",
                "Operator": "IS",
                "Values": [
                  "USA"
                  ]
                }
              ],
            "PayoutRate": "15",
            "Limits": [
              {
                "Type": "PAYOUT",
                "Value": "45.0",
                "LimitBy": "ITEM",
                "Period": "DAY"
                }
              ]
            },
          {
            "Id": "90opqrs1-2t34-5678-9012-345u67v890w1",
            "Rank": "2",
            "Rules": [
              {
                "Variable": "ITEM_DISCOUNT",
                "Operator": "IS",
                "Values": [
                  "60"
                  ]
                }
              ],
            "Payout": "15.00"
          }
        ],
        "PayoutAdjustments": [
          {
            "Id": "x234y567-8901-2z3a-4567-8b9012345c67",
            "Rules": [
              {
                "Variable": "CUSTOMER_STATUS",
                "Operator": "IS",
                "Values": [
                  "FREQUENT"
                  ]
                }
              ],
            "Direction": "INCREASE",
            "Rate": "15"
          }
        ],
        "PerformanceBonus": {
          "Type": "ALL_ACTIONS",
          "Basis": "REVENUE",
          "Period": "CALENDAR_MONTH",
          "Tiers": [
            {
              "RevenueThreshold": "15.00",
              "PayoutRate": "60"
              }
            ]
          },
        "PayoutRestrictions": [
          {
            "Id": "8d9012ef-gh34-56i7-jk89-012345l67890",
            "Rules": [
              {
                "Variable": "PATH_MEDIA_COUNT",
                "Operator": "IS",
                "Values": [
                  "50"
                  ]
                }
              ]
            }
          ],
        "Limits": [
          {
            "Type": "ACTION",
            "Value": "100.0",
            "LimitBy": "CUSTOMER",
            "Period": "DAY",
            "WeekendOverrideValue": "500"
            }
          ],
        "Locking": {
          "Basis": "TRACKED",
          "Period": "MONTH",
          "MonthOffset": "1",
          "DayOffset": "0",
          "DayOfMonth": "0"
          },
        "PayoutScheduling": {
          "Basis": "LOCKED",
          "Period": "END_OF_MONTH"
          },
        "CreditPolicy": "LAST_REFERRER",
          "ValidReferrals": [
            {
              "Type": "CLICKS",
              "Window": "30",
              "WindowUnit": "DAY"
              }
            ]
          }
        ],
      "SpecialTermsList": [
        {
          "TermsName": "Custom Terms",
          "TermsType": "CUSTOM",
          "TermsContent": "<p>These are custom terms</p>\r\n"
          }
        ],
      "ChangeNotificationPeriod": "20",
      "ReturnPolicy": "ALWAYS_OK",
      "MaxReturnPercentage": "100",
      "ActionLimit": "1500",
      "ActionLimitPeriod": "MONTH",
      "SpendLimit": "10000.00",
      "SpendLimitPeriod": "MONTH",
      "MinEarningPerClick": "0.00",
      "ContractStartSlottingFee": "50.00",
      "CustomCreativePayer": "ADVERTISER"
    },
  "PdfUri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777/Download",
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777"
}

Attributes

Id string

PartnerId integer

PartnerValue1 string

Status enum

StartDate datetime

EndDate datetime

BrandSignatory string

BrandSignatoryDate datetime

PartnerSignatory string

PartnerSignatoryDate datetime

DateCreated datetime

DateLastUpdated datetime

TemplateTerms object

TemplateId integer

VersionId integer

Name string

Labels array

Currency enum

EventPayouts array

EventTypeId integer

EventTypeName string

EventCategory enum

DefaultPayout decimal

DefaultPayoutRate decimal

PayoutLevel enum

PayoutGroups array

Id string

Rank integer

Rules array

Variable enum

Operator enum

Values array

Payout decimal

PayoutRate integer

Limits array

Type enum

Subtype enum

Value decimal

LimitBy enum

Period enum

WeekendOverrideValue integer

Tiers array

RevenueThreshold decimal

ActionThreshold integer

ParentTier integer

Payout decimal

PayoutRate decimal

PayoutAdjustments array

Id string

Rules array

Variable enum

Operator enum

Values array

Direction enum

Amount decimal

Rate integer

PerformanceBonus array

Type enum

Basis enum

Period enum

BonusTiers array

RevenueThreshold decimal

Minimum revenue needed for the next bonus tier to initiate. If used, ActionThreshold will not appear for this payout group.

ActionThreshold integer

Minimum number of actions needed for the next bonus tier to initiate. If used, RevenueThreshold will not appear for this payout group.

Payout decimal

PayoutRate decimal

PayoutRestrictions array

Id string

Rules array

Variable enum

Operator enum

Values array

Limits array

Type enum

Subtype enum

Value decimal

LimitBy enum

Period enum

`Id` string

`PartnerId` integer

`PartnerValue1` string

`Status` enum

`StartDate` datetime

`EndDate` datetime

`BrandSignatory` string

`BrandSignatoryDate` datetime

`PartnerSignatory` string

`PartnerSignatoryDate` datetime

`DateCreated` datetime

`DateLastUpdated` datetime

`TemplateTerms` object

`TemplateId` integer

`VersionId` integer

`Name` string

`Labels` array

`Currency` enum

`EventPayouts` array

`EventTypeId` integer

`EventTypeName` string

`EventCategory` enum

`DefaultPayout` decimal

`DefaultPayoutRate` decimal

`PayoutLevel` enum

`PayoutGroups` array

`Id` string

`Rank` integer

`Rules` array

`Variable` enum

`Operator` enum

`Values` array

`Payout` decimal

`PayoutRate` integer

`Limits` array

`Type` enum

`Subtype` enum

`Value` decimal

`LimitBy` enum

`Period` enum

`WeekendOverrideValue` integer

`Tiers` array

`RevenueThreshold` decimal

`ActionThreshold` integer

`ParentTier` integer

`Payout` decimal

`PayoutRate` decimal

`PayoutAdjustments` array

`Id` string

`Rules` array

`Variable` enum

`Operator` enum

`Values` array

`Direction` enum

`Amount` decimal

`Rate` integer

`PerformanceBonus` array

`Type` enum

`Basis` enum

`Period` enum

`BonusTiers` array

`RevenueThreshold` decimal

Minimum revenue needed for the next bonus tier to initiate. If used, `ActionThreshold` will not appear for this payout group.

`ActionThreshold` integer

Minimum number of actions needed for the next bonus tier to initiate. If used, `RevenueThreshold` will not appear for this payout group.

`Payout` decimal

`PayoutRate` decimal

`PayoutRestrictions` array

`Id` string

`Rules` array

`Variable` enum

`Operator` enum

`Values` array

`Limits` array

`Type` enum

`Subtype` enum

`Value` decimal

`LimitBy` enum

`Period` enum

`WeekendOverrideValue` integer