Skip to content

Latest commit

 

History

History
45 lines (24 loc) · 2.88 KB

NewDealProduct.md

File metadata and controls

45 lines (24 loc) · 2.88 KB
Raw

Pipedrive.NewDealProduct

Properties

Name Type Description Notes
product_id Number The ID of the product to use [optional]
item_price Number The price at which this product will be added to the deal [optional]
quantity Number How many items of this product will be added to the deal [optional]
discount Number The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage [optional] [default to 0]
discount_type String The type of the discount's value [optional] [default to 'percentage']
product_variation_id Number The ID of the product variation to use. When omitted, no variation will be used [optional]
comments String A textual comment associated with this product-deal attachment [optional]
tax Number The tax percentage [optional] [default to 0]
tax_method String The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount [optional]
enabled_flag Boolean Whether the product is enabled for a deal or not This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default Not possible to disable the product if the deal has installments associated and the product is the last one enabled Not possible to enable the product if the deal has installments associated and the product is recurring [optional] [default to true]
billing_frequency BillingFrequency [optional]
billing_frequency_cycles Number Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 [optional]
billing_start_date String Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future [optional]

Enum: DiscountTypeEnum

  • percentage (value: "percentage")

  • amount (value: "amount")

Enum: TaxMethodEnum

  • exclusive (value: "exclusive")

  • inclusive (value: "inclusive")

  • none (value: "none")