# Models

## The ActionState object

```json
{"openapi":"3.1.0","info":{"title":"Impact Publisher Actions API","version":"15"},"components":{"schemas":{"ActionState":{"type":"string","description":"The current state of the action.","enum":["PENDING","APPROVED","REVERSED"]}}}}
```

## The Action object

```json
{"openapi":"3.1.0","info":{"title":"Impact Publisher Actions API","version":"15"},"components":{"schemas":{"Action":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the action."},"CampaignId":{"type":"integer","description":"Unique identifier for the campaign that the action is associated with."},"CampaignName":{"type":"string","description":"Display name for the campaign that the action is associated with."},"ActionTrackerId":{"type":"integer","description":"Unique identifier for the action tracker (event type) that tracked the conversion."},"ActionTrackerName":{"type":"string","description":"Display name for the action tracker (event type) that tracked the conversion."},"State":{"$ref":"#/components/schemas/ActionState","description":"The current state of the action:\n- `PENDING`: Awaiting the locking date for automatic approval, or manual review. Modified actions also have this state.\n- `APPROVED`: Approved and will pay out to the partner. No further modifications are possible.\n- `REVERSED`: Reversed and will not pay out to the partner.\n"},"AdId":{"type":"integer","description":"Unique identifier for the ad that drove the winning click."},"Payout":{"type":"string","format":"decimal","description":"Commission amount calculated for the action that will be paid out to the partner."},"Amount":{"type":"string","format":"decimal","description":"Revenue amount associated with the action."},"Currency":{"type":"string","description":"Three-letter ISO 4217 code representing the currency for the action."},"EventDate":{"type":"string","format":"date-time","description":"Date and time when the conversion event occurred."},"LockingDate":{"type":"string","format":"date-time","description":"Date and time when the action will lock and can no longer be modified or reversed."},"Oid":{"type":"string","description":"The unique identifier for the order associated with this conversion, as provided by the brand."},"EventCode":{"type":"string","description":"For mobile app events, populates with the event code representing the type of event tracked."},"SharedId":{"type":"string","description":"The Shared ID value associated with the winning click. A query string parameter you can append to the tracking link to share traffic segments with the brand."},"SubId1":{"type":"string","description":"The first Sub ID value associated with the winning click. A query string parameter you can append to the tracking link that will appear in your reporting."},"SubId2":{"type":"string","description":"The second Sub ID value associated with the winning click. A query string parameter you can append to the tracking link that will appear in your reporting."},"SubId3":{"type":"string","description":"The third Sub ID value associated with the winning click. A query string parameter you can append to the tracking link that will appear in your reporting."},"DeltaPayout":{"type":"string","format":"decimal","description":"The change in payout value between the current action update and the previous one."},"IntendedPayout":{"type":"string","format":"decimal","description":"Original payout amount calculated by the template terms before any modifications."},"DeltaAmount":{"type":"string","format":"decimal","description":"The change in amount value between the current action update and the previous one."},"IntendedAmount":{"type":"string","format":"decimal","description":"Original amount for the action before any modifications."},"ReferringDate":{"type":"string","format":"date-time","description":"Date and time when the winning click occurred."},"CreationDate":{"type":"string","format":"date-time","description":"Date and time when the action was created in impact.com."},"ClearedDate":{"type":"string","format":"date-time","description":"Date and time when the action commission cleared your account balance. Returns empty if the action has not cleared yet."},"ReferringType":{"type":"string","description":"The attribution method associated with the winning referral.","enum":["CLICK_COOKIE","CLICK_FINGERPRINT","CALL","PROMOCODE","ACTION","REPORTED_PARTNER_ID","IMPRESSION_COOKIE","IMPRESSION_FINGERPRINT","ACTION_INQUIRY"]},"ReferringDomain":{"type":"string","description":"Domain of the site that the winning click occurred on."},"PromoCode":{"type":"string","description":"The promotional code applied to the conversion, if one was used."},"CustomerArea":{"type":"string","description":"The Designated Market Area (DMA) code of the customer's area, derived from IP address."},"CustomerCity":{"type":"string","description":"The city the customer resides in."},"CustomerRegion":{"type":"string","description":"The region or state the customer resides in."},"CustomerCountry":{"type":"string","description":"The country the customer resides in."},"Uri":{"type":"string","description":"Unique reference to the action object in the impact.com API."}}},"ActionState":{"type":"string","description":"The current state of the action.","enum":["PENDING","APPROVED","REVERSED"]}}}}
```

## The Item object

```json
{"openapi":"3.1.0","info":{"title":"Impact Publisher Actions API","version":"15"},"components":{"schemas":{"Item":{"type":"object","properties":{"Sku":{"type":"string","description":"The product identifier or SKU for the item."},"ItemName":{"type":"string","description":"The product name or description."},"Category":{"type":"string","description":"The product category."},"Quantity":{"type":"string","description":"The number of units purchased."},"SaleAmount":{"type":"string","description":"The transaction value or sale amount for the item."},"SaleAmountCurrency":{"type":"string","description":"The currency code for the sale amount."},"Payout":{"type":"string","format":"decimal","description":"The commission or payout earned for the item."},"PayoutCurrency":{"type":"string","description":"The currency code for the payout."},"Rebate":{"type":"string","description":"The rebate amount for the item."},"RebateCurrency":{"type":"string","description":"The currency code for the rebate."},"AdjustmentDate":{"type":"string","format":"date-time","description":"The date and time of any adjustment applied to the item. Returns empty if no adjustment has occurred."},"AdjustmentReason":{"type":"string","description":"The reason for any adjustment applied to the item. Returns empty if no adjustment has occurred.","enum":["OVERLIMIT_WEEKDAYCAP","OVERLIMIT_WEEKENDCAP","OVERLIMIT_BUDGET","OVERLIMIT_ACTIONCAP","OVERLIMIT_CONCURRENTCALLS","OVERLIMIT_UNKNOWN_CALLERID","RECALC_COMM","MP_RETURN","APPROVED","REJECTED","CONS_INFO_INVALID","CONS_ERROR","CONS_FRAUD","ITEM_RETURNED","ITEM_OUT_OF_STOCK","ORDER_ERROR","PUB_ACT_DISPUTE","ADV_ACT_DISPUTE","NOT_COMPLIANCE_TERMS","MP_ACCOUNT_DEATVIATED","CREDITED_DIFFERENT_MP","ORDER_UPDATE","OTHER","TEST_ACTION","RESET"]},"Uri":{"type":"string","description":"Unique reference to the action item object in the impact.com API."}}}}}}
```

## The ActionUpdate object

```json
{"openapi":"3.1.0","info":{"title":"Impact Publisher Actions API","version":"15"},"components":{"schemas":{"ActionUpdate":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the action update record."},"ActionId":{"type":"string","description":"Identifier for the parent action associated with this update."},"CampaignId":{"type":"integer","description":"Unique identifier for the campaign associated with the action."},"ActionTrackerId":{"type":"string","description":"Unique identifier of the action tracker (event type) that recorded the action."},"EventCode":{"type":"string","description":"Internal event code associated with the action tracker."},"State":{"$ref":"#/components/schemas/ActionState","description":"The current state of the action:\n- `PENDING`: Awaiting the locking date for automatic approval, or manual review.\n- `APPROVED`: Approved and will pay out to the partner.\n- `REVERSED`: Reversed and will not pay out to the partner.\n"},"StateDetail":{"type":"string","description":"Additional detail about the current state of the action."},"StateDetailDescription":{"type":"string","description":"Human-readable explanation of the state detail."},"AdId":{"type":"string","description":"Unique identifier of the ad that drove the action, if applicable."},"ReportingState":{"type":"string","description":"The reporting state of the action used by impact.com analytics."},"DeltaPayout":{"type":"string","format":"decimal","description":"The change in payout amount between this update and the previous one."},"DeltaAmount":{"type":"string","format":"decimal","description":"The change in transaction amount between this update and the previous one."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code for the action amounts."},"Category":{"type":"string","description":"Brand-defined category for the action."},"Sku":{"type":"string","description":"Stock keeping unit identifier for the product associated with the action, if applicable."},"Quantity":{"type":"string","description":"Quantity of items associated with the action."},"CatalogName":{"type":"string","description":"Name of the catalog the action item belongs to."},"CatalogCategory":{"type":"string","description":"Category of the action item from the brand's catalog."},"CatalogDescription":{"type":"string","description":"Description of the action item from the brand's catalog."},"CatalogManufacturer":{"type":"string","description":"Manufacturer of the action item from the brand's catalog."},"CatalogOriginalFormatCategory":{"type":"string","description":"Original (unmodified) category of the action item from the brand's catalog."},"CatalogSubCategory":{"type":"string","description":"Sub-category of the action item from the brand's catalog."},"UpdateDate":{"type":"string","format":"date-time","description":"Date and time of the most recent modification to the action."},"LockingDate":{"type":"string","format":"date-time","description":"Date and time the action will be (or was) locked for automatic state changes."},"ClearingDate":{"type":"string","format":"date-time","description":"Date and time the action payout was (or will be) cleared for payment."},"ActionDate":{"type":"string","format":"date-time","description":"Date and time when the original action or conversion event occurred."},"Oid":{"type":"string","description":"The unique identifier for the order associated with the action, as provided by the brand."},"SubId1":{"type":"string","description":"First partner sub-identifier passed on the tracking link."},"SubId2":{"type":"string","description":"Second partner sub-identifier passed on the tracking link."},"SubId3":{"type":"string","description":"Third partner sub-identifier passed on the tracking link."},"PaystubId":{"type":"string","description":"Identifier of the paystub the action's payout is associated with, when paid."},"ContractId":{"type":"string","description":"Identifier of the contract that determined the payout for this action."},"EventTypeId":{"type":"string","description":"Unique identifier of the event type that recorded the action."},"EventTypeName":{"type":"string","description":"Display name of the event type that recorded the action."},"PayoutLevel":{"type":"string","description":"The level at which the payout was calculated (e.g., `ORDER`, `ITEM`)."},"DefaultPayout":{"type":"string","format":"decimal","description":"Default payout amount before any adjustments."},"DefaultPayoutCurrency":{"type":"string","description":"Three-letter ISO 4217 currency code for the default payout amount."},"SharedId":{"type":"string","description":"Shared identifier passed on the tracking link."},"ActionUri":{"type":"string","description":"API resource path to the parent action."},"Uri":{"type":"string","description":"Unique reference to the action update object in the impact.com API."}}},"ActionState":{"type":"string","description":"The current state of the action.","enum":["PENDING","APPROVED","REVERSED"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://integrations.impact.com/partner-api-reference/partner-v15/reference/actions/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.