# Models ## The Action object ```json {"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v12"},"components":{"schemas":{"Action":{"type":"object","description":"Represents a conversion event credited to a partner.","properties":{"Id":{"type":"string","description":"Unique impact.com identifier for the action."},"CampaignId":{"type":"integer","description":"Unique identifier for the campaign (program) this action belongs to."},"CampaignName":{"type":"string","description":"Display name of the campaign."},"ActionTrackerId":{"type":"integer","description":"Unique identifier for the action tracker (event type) that recorded this action."},"ActionTrackerName":{"type":"string","description":"Display name of the action tracker (event type)."},"EventCode":{"type":"string","description":"The event code associated with the action tracker, if configured."},"MediaPartnerId":{"type":"integer","description":"Unique identifier for the partner credited for this action."},"MediaPartnerName":{"type":"string","description":"Display name of the credited partner."},"State":{"type":"string","description":"Current state of the action.\n- `PENDING`: Awaiting locking date or manual approval. Modified actions also carry this state.\n- `APPROVED`: Reached its locking date or was manually approved. Will pay out the partner.\n- `REVERSED`: Was reversed and will not pay out the partner.\n","enum":["PENDING","APPROVED","REVERSED"]},"AdId":{"type":"integer","description":"Unique identifier for the ad creative that drove the winning click."},"ClientCost":{"type":"number","description":"The total cost to the brand for this action (payout plus any fees)."},"Payout":{"type":"number","description":"Commission amount to be paid to the partner."},"DeltaPayout":{"type":"number","description":"The change in payout value from the most recent modification. Equals Payout for unmodified actions."},"IntendedPayout":{"type":"number","description":"The originally intended payout before any modifications."},"Amount":{"type":"number","description":"Revenue amount (sale amount) associated with this action."},"DeltaAmount":{"type":"number","description":"The change in sale amount from the most recent modification. Equals Amount for unmodified actions."},"IntendedAmount":{"type":"number","description":"The originally intended sale amount before any modifications."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code for monetary values in this action."},"ReferringDate":{"type":"string","format":"date-time","description":"Timestamp of the winning click that led to this conversion."},"EventDate":{"type":"string","format":"date-time","description":"Timestamp of when the conversion event occurred."},"CreationDate":{"type":"string","format":"date-time","description":"Timestamp of when this action record was created in impact.com."},"LockingDate":{"type":"string","format":"date-time","description":"Date after which the action can no longer be modified. Once passed, a Pending action moves to Approved."},"ClearedDate":{"type":"string","format":"date-time","nullable":true,"description":"Date when the commission for this action was cleared and paid out. Empty if not yet cleared."},"ReferringType":{"type":"string","description":"The type of referral that drove the winning click (e.g., `CLICK_COOKIE`, `CLICK_FINGERPRINT`)."},"ReferringDomain":{"type":"string","description":"Domain of the website where the winning click occurred. May be empty."},"PromoCode":{"type":"string","description":"Promotional code applied during the conversion, if any."},"Oid":{"type":"string","description":"Your unique identifier for the order associated with this action."},"CustomerId":{"type":"string","description":"Your unique, non-PII identifier for the customer who made the conversion."},"CustomerStatus":{"type":"string","description":"A custom status label for the customer, as defined in your event type settings (e.g., `NEW`, `EXISTING`)."},"CustomerPostCode":{"type":"string","description":"Postal code of the customer, if passed at conversion time."},"CustomerArea":{"type":"string","description":"Area or neighbourhood of the customer, if passed at conversion time."},"CustomerCity":{"type":"string","description":"City of the customer, if passed at conversion time."},"CustomerRegion":{"type":"string","description":"State or region of the customer, if passed at conversion time."},"CustomerCountry":{"type":"string","description":"Two-letter ISO country code for the customer's country, if passed at conversion time."},"IpAddress":{"type":"string","description":"Hashed IP address of the customer at the time of conversion."},"SharedId":{"type":"string","description":"The Shared ID value passed from the winning click, used for cross-device or cross-channel attribution."},"CallerId":{"type":"string","description":"Caller ID associated with the action, used in call tracking integrations."},"Note":{"type":"string","description":"Free-text note attached to the action, if any."},"Uri":{"type":"string","description":"Unique URI reference to this action object."}}}}}} ``` ## The ActionItem object ```json {"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v12"},"components":{"schemas":{"ActionItem":{"type":"object","description":"Represents a single line item within an action.","properties":{"Sku":{"type":"string","description":"Stock-keeping unit (SKU) or product identifier for the item."},"ItemName":{"type":"string","description":"Display name of the product."},"Category":{"type":"string","description":"Product category for the item."},"Quantity":{"type":"string","description":"Number of units of this product in the order."},"SaleAmount":{"type":"string","description":"Revenue amount for this line item."},"SaleAmountCurrency":{"type":"string","description":"Three-letter ISO 4217 currency code for the sale amount."},"Payout":{"type":"number","description":"Commission amount for this line item."},"PayoutCurrency":{"type":"string","description":"Three-letter ISO 4217 currency code for the payout amount."},"Rebate":{"type":"number","description":"Discount or rebate amount applied to this item."},"RebateCurrency":{"type":"string","description":"Three-letter ISO 4217 currency code for the rebate amount."},"AdjustmentDate":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp of the most recent adjustment to this item. Empty if the item has not been modified."},"AdjustmentReason":{"type":"string","description":"The reason code for the most recent adjustment to this item."},"Uri":{"type":"string","description":"Unique URI reference to this action item object."}}}}}} ``` ## The ActionUpdate object ```json {"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v12"},"components":{"schemas":{"ActionUpdate":{"type":"object","description":"Represents a single modification event in an action's lifecycle. Each time an action changes state or is modified, a new ActionUpdate record is created.","properties":{"Id":{"type":"string","description":"Unique identifier for this action update record."},"ActionId":{"type":"string","description":"Unique identifier for the parent action that was updated."},"CampaignId":{"type":"integer","description":"Unique identifier for the campaign this action belongs to."},"ActionTrackerId":{"type":"integer","description":"Unique identifier for the action tracker (event type)."},"MediaPartnerId":{"type":"integer","description":"Unique identifier for the partner credited for this action."},"State":{"type":"string","description":"The state of the action at the time of this update.","enum":["PENDING","APPROVED","REVERSED"]},"StateDetail":{"type":"string","description":"A short code providing additional detail about the action's state (e.g., `PAID`, `OVERDUE`)."},"AdId":{"type":"integer","description":"Unique identifier for the ad creative that drove the winning click."},"DeltaPayout":{"type":"number","description":"The change in payout value recorded by this update."},"DeltaAmount":{"type":"number","description":"The change in sale amount recorded by this update."},"Category":{"type":"string","description":"Product category of the item associated with this update."},"Sku":{"type":"string","description":"SKU of the item associated with this update."},"Quantity":{"type":"string","description":"Quantity of the item at the time of this update."},"CatalogName":{"type":"string","description":"Name of the product catalog entry associated with the item, if applicable."},"CatalogCategory":{"type":"string","description":"Category from the product catalog entry associated with the item, if applicable."},"UpdateDate":{"type":"string","format":"date-time","description":"Timestamp of when this update was recorded."},"LockingDate":{"type":"string","format":"date-time","description":"Date after which the action can no longer be modified."},"ClearingDate":{"type":"string","format":"date-time","nullable":true,"description":"Date when the commission is scheduled to clear."},"ActionDate":{"type":"string","format":"date-time","description":"Timestamp of the original conversion event."},"Oid":{"type":"string","description":"Your unique identifier for the order associated with the parent action."},"CustomerId":{"type":"string","description":"Your unique, non-PII identifier for the customer."},"CustomerStatus":{"type":"string","description":"The customer status label at the time of this update."},"SharedId":{"type":"string","description":"The Shared ID value from the winning click."},"ActionUri":{"type":"string","description":"URI reference to the parent action object."},"Uri":{"type":"string","description":"Unique URI reference to this action update object."}}}}}} ``` --- # 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/brand-api-reference/brand-api-reference-v12/reference/actions/models.md?ask= ``` 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.