{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Deals","projectTitle":"Frontline Documentation","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"deals","__idx":0},"children":["Deals"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deals"]}," object stores sales opportunities. It is extensible but cannot be deleted."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"standard-fields","__idx":1},"children":["Standard fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Behavior"},"children":["Behavior"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required record title."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Stage"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["select"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required pipeline stage. Defaults to Lead."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Users"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["prismaRelation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Assigned Frontline account users."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number (currency, USD)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Deal monetary value."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Last Status Change"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["date"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read-only timestamp updated when Stage changes."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The default Stage options are Lead, In Progress, Won, and Lost. These options can be customized for the account."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"built-in-relations","__idx":2},"children":["Built-in relations"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Relation"},"children":["Relation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Target"},"children":["Target"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Cardinality"},"children":["Cardinality"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["People"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["people"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Many-to-many"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Company"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companies"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Many-to-one"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The relations are already defined. Link records with the relation endpoints rather than creating replacement fields."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pipeline-behavior","__idx":3},"children":["Pipeline behavior"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deals use a Kanban view grouped by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Stage"]}," by default. The default view also includes a sum aggregation on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Value"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whenever Stage changes, Frontline updates ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Last Status Change"]}," automatically. Do not maintain a duplicate timestamp field through a workflow."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example","__idx":4},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"frontline object record create deals --data '{\n  \"Name\": \"Acme expansion\",\n  \"Stage\": \"Lead\",\n  \"Value\": 25000\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Inspect the live schema and Stage options before writing records:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"frontline object schema deals\nfrontline object field list deals\n","lang":"bash"},"children":[]}]},"headings":[{"value":"Deals","id":"deals","depth":1},{"value":"Standard fields","id":"standard-fields","depth":2},{"value":"Built-in relations","id":"built-in-relations","depth":2},{"value":"Pipeline behavior","id":"pipeline-behavior","depth":2},{"value":"Example","id":"example","depth":2}],"frontmatter":{"seo":{"title":"Deals"}},"lastModified":"2026-07-30T19:19:43.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/concepts/standard-objects/deals","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}