DEALPRODUCT: Deal Product
A junction entity linking a deal to a product with quantity, pricing, and discount information.
Default definition. This article describes the default
DEALPRODUCT definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches DEALPRODUCT.Entity properties
| Property | Value |
|---|---|
| Entity code | DEALPRODUCT |
| Display name | Deal Product |
| Plural | Deal Products |
| Level | 231 |
Use cases
DEALPRODUCT is a junction between DEAL and PROD. comboKey uses SUB|DEAL format. The product field is an objectLookup to PROD. Financial fields include quantity, unitPrice, discount, and lineTotal. lineTotal is computed client-side as quantity * unitPrice * (1 - discount/100).
Fields
Product Line
| Field | Type | Required | Notes |
|---|---|---|---|
product | reference → PROD | Yes | Product. |
quantity | number | Yes | Quantity. |
unitPrice | number | Yes | Unit Price. |
discount | number | Discount %. | |
lineTotal | number | Line Total. Read only. |
Details
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Optional override name for this line item | |
description | text (multi-line) | Notes. | |
recurringType | enum | Valid ids: oneoff (One-off), monthly (Monthly), annual (Annual), quarterly (Quarterly). |
Relationships
- Lookup:
product(reference →PROD).
Creating a Deal Product via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "DEALPRODUCT",
"level": 231,
"comboKey": "SUB:<your-sub-id>|ENT:",
"product": "",
"quantity": 0,
"unitPrice": 0,
"name": "Example name"
} Listing Deal Products records
GET /v1/entities/DEALPRODUCT/SUB:<your-sub-id>