Deal
A deal represents an opportunity to increase revenue. The Deal type in Bunny's GraphQL API and its fields.
| Name | Type | Description |
|---|---|---|
| account | Account | Account the deal belongs to |
| accountId | ID | Account that the deal belongs to |
| amount | Float | Total value of the deal |
| closeDate | ISO8601Date | Datetime the deal closed |
| closeUrgency | String | Overdue, This week, Within 30 days or Later — for urgency-coloured columns |
| code | String | Unique code |
| contact | Contact | Primary contact for the deal |
| contactId | ID | Primary contact for the deal |
| createdAt | ISO8601DateTime | Datetime the deal was created |
| currency | Currency | Primary currency for billing |
| currencyId | ID | Primary currency for billing |
| customFieldDefinitions | List (CustomField) | Custom field definitions for this object type |
| customFieldsData | JSON | All custom field values for this object as a JSON object |
| dealStage | Deal | Current stage of the deal |
| dealStageId | ID | Current stage of the deal |
| description | String | Description of the deal |
| entity | Entity | The entity this deal belongs to |
| entityId | ID | The ID of the entity this deal belongs to |
| hasCustomFields | Boolean | Whether this object type has any custom fields defined |
| id | ID | Unique identifier for the deal |
| kind | DealKind | The kind of deal |
| leadSourceId | ID | Lead source for the deal |
| name | String | Name of the deal |
| notForRevenue | Boolean | Will exclude this deal from analytics |
| origin | DealOrigin | Describes the origin of the deal: sales, portal, signup etc |
| owner | User | Owner of the deal |
| ownerUserId | ID | Owner of the deal |
| pipeline | String | Which pipeline the deal belongs to: sales or renewal |
| probability | Int | Probability that the deal will close |
| quoteDefaults | Quote | Default values for a new quote based on this deal |
| quotes | List (Quote) | Quotes on the deal |
| renewalCurrentAmount | Float | Baseline (current) ARR for a renewal deal |
| renewalMrr | Float | Monthly recurring revenue for a renewal deal (current ARR / 12) |
| renewalNeedsAttention | Boolean | Renewal is close to its date but has had no activity (still Quote drafted) |
| stageDescription | ID | Description of the deal stage |
| updatedAt | ISO8601DateTime | Datetime the deal was last updated |
| viaPortal | Boolean | Whether the deal was created from Portal UI or not |