> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cutmeshort.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Field Reference

> Complete reference for attribution, conversion, and user detail fields used in lead and sale tracking.

## Attribution Fields

These fields form the backbone of click-to-conversion tracking. They tell CutMeShort *where* a conversion came from and *who* made it.

### `clickId`

<Warning>
  Never generate your own `clickId`. Always reuse the value created by the tracking script.
</Warning>

The click-level attribution identifier — the unique fingerprint of the original tracked click.

| Property    | Detail                                                                         |
| ----------- | ------------------------------------------------------------------------------ |
| **Source**  | CutMeShort captures it when the script detects `cms_rf` in the URL             |
| **Storage** | Persisted in cookies by the tracking script for later reuse                    |
| **Usage**   | Pass in lead and sale events to link conversions back to the originating click |

### `customerExternalId`

<Warning>
  Do not create a new value at sale time or in follow-up lead events. Use the same identifier across all events for the same customer.
</Warning>

Your stable customer identifier — the consistent key that connects a customer's journey end-to-end.

| Property    | Detail                                                         |
| ----------- | -------------------------------------------------------------- |
| **Source**  | Your application, auth system, CRM, or backend user record     |
| **Usage**   | Keep it unchanged across lead and sale events                  |
| **Purpose** | Allows CutMeShort to stitch the full customer journey together |

### `eventName`

A human-readable label describing the lead milestone being recorded.

| Property     | Detail                                                                  |
| ------------ | ----------------------------------------------------------------------- |
| **Examples** | `signup_started`, `email_verified`, `purchase_completed`                |
| **Source**   | Your product logic or event naming convention                           |
| **Usage**    | Send a meaningful name that describes exactly what lead action occurred |

### `mode`

> **Deferred lead flows only.** Only use this on the initial event of a deferred tracking sequence.

A flag that controls how lead attribution is recorded when you need to defer tracking.

| Property        | Detail                                                               |
| --------------- | -------------------------------------------------------------------- |
| **Valid value** | `"deferred"`                                                         |
| **Source**      | Set by your app when you intentionally want deferred tracking        |
| **Usage**       | Set to `"deferred"` for the first event in a deferred lead flow only |

## Conversion Fields

These fields carry the financial and transactional data for a sale event.

### `amount`

The monetary value associated with the sale.

| Property   | Detail                                                                    |
| ---------- | ------------------------------------------------------------------------- |
| **Source** | Your payment provider, checkout session, order record, or billing backend |
| **Usage**  | Send the final sale amount for the conversion being attributed            |

<Warning>
  Make sure the value matches the currency you send alongside it.
</Warning>

### `currency`

The ISO 4217 currency code for the sale amount.

| Property   | Detail                                       |
| ---------- | -------------------------------------------- |
| **Format** | 3-letter ISO code — e.g. `USD`, `EUR`, `INR` |
| **Source** | Your billing or checkout system              |
| **Usage**  | Always pair with the `amount` field          |

<Warning>
  Keep the code consistent with the actual transaction currency to ensure accurate revenue reporting.
</Warning>

### `invoiceId`

The unique transaction or order reference for a sale.

| Property      | Detail                                                               |
| ------------- | -------------------------------------------------------------------- |
| **Source**    | Your payment processor, order table, or billing system               |
| **Usage**     | Use to deduplicate repeated submissions and reconcile revenue events |
| **Stability** | Must remain the same for the same transaction                        |

## User Detail Fields

These fields are **optional enrichment data**. They don't drive attribution, but they make lead and sale records significantly more useful in analytics and reporting.

### `customerName`

The customer's full display name.

| Property   | Detail                                                    |
| ---------- | --------------------------------------------------------- |
| **Source** | Signup form, profile record, CRM, or auth provider        |
| **Usage**  | Send when you have a reliable, user-facing name available |

### `customerEmail`

The email address associated with the lead or customer.

| Property   | Detail                                                                    |
| ---------- | ------------------------------------------------------------------------- |
| **Source** | Signup form, login flow, or profile record                                |
| **Usage**  | Include when available to improve identity matching and reporting quality |

## Quick Reference

| Field                | Type     | Required    | Used In          |
| -------------------- | -------- | ----------- | ---------------- |
| `clickId`            | `string` | Recommended | Leads, Sales     |
| `customerExternalId` | `string` | Recommended | Leads, Sales     |
| `eventName`          | `string` | Required    | Leads, Sales     |
| `mode`               | `string` | Conditional | Leads (deferred) |
| `amount`             | `number` | Required    | Sales            |
| `currency`           | `string` | Required    | Sales            |
| `invoiceId`          | `string` | Recommended | Sales            |
| `customerName`       | `string` | Optional    | Leads, Sales     |
| `customerEmail`      | `string` | Optional    | Leads, Sales     |

## Related Docs

* [Lead Track](/api-reference/endpoint/Lead)
* [Sale Track](/api-reference/endpoint/Sale)