The Selling Settings object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

cust_master_name string

Default: Customer Name

customer_group string
territory string
selling_price_list string
so_required string
dn_required string
sales_update_frequency string

Default: Daily

maintain_same_sales_rate boolean

Default: false

editable_price_list_rate boolean

Default: false

allow_multiple_items boolean

Default: false

allow_against_multiple_purchase_orders boolean

Default: false

validate_selling_price boolean

Default: false

hide_tax_id boolean

Default: false

maintain_same_rate_action string

Default: Stop

role_to_override_stop_action string
editable_bundle_item_rates boolean

Default: false

enable_discount_accounting boolean

Default: false

allow_sales_order_creation_for_expired_quotation boolean

Default: false

dont_reserve_sales_order_qty_on_sales_return boolean

Default: false

allow_negative_rates_for_items boolean

Default: false

blanket_order_allowance number
enable_cutoff_date_on_bulk_delivery_note_creation boolean

Default: false

allow_zero_qty_in_sales_order boolean

Default: false

allow_zero_qty_in_quotation boolean

Default: false

allow_delivery_of_overproduced_qty boolean

Default: false

fallback_to_default_price_list boolean

Default: false

use_legacy_js_reactivity boolean

Default: false

set_zero_rate_for_expired_batch boolean

Default: false

enable_tracking_sales_commissions boolean

Default: false

enable_utm boolean

Default: false

deliver_secondary_items boolean

Default: false

The Selling Settings object 
{
  "id": "selling-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "cust_master_name": "Customer Name",
  "customer_group": "customer_group_example",
  "territory": "territory_example",
  "selling_price_list": "selling_price_list_example",
  "so_required": "so_required_example",
  "dn_required": "dn_required_example",
  "sales_update_frequency": "Daily",
  "maintain_same_sales_rate": false,
  "editable_price_list_rate": false,
  "allow_multiple_items": false,
  "allow_against_multiple_purchase_orders": false,
  "validate_selling_price": false,
  "hide_tax_id": false,
  "maintain_same_rate_action": "Stop",
  "role_to_override_stop_action": "role_to_override_stop_action_example",
  "editable_bundle_item_rates": false,
  "enable_discount_accounting": false,
  "allow_sales_order_creation_for_expired_quotation": false,
  "dont_reserve_sales_order_qty_on_sales_return": false,
  "allow_negative_rates_for_items": false,
  "blanket_order_allowance": 0,
  "enable_cutoff_date_on_bulk_delivery_note_creation": false,
  "allow_zero_qty_in_sales_order": false,
  "allow_zero_qty_in_quotation": false,
  "allow_delivery_of_overproduced_qty": false,
  "fallback_to_default_price_list": false,
  "use_legacy_js_reactivity": false,
  "set_zero_rate_for_expired_batch": false,
  "enable_tracking_sales_commissions": false,
  "enable_utm": false,
  "deliver_secondary_items": false
}
GET /api/crm/selling-settings

Retrieve selling settings

Retrieves the current selling settings. This is a singleton resource.

Returns

Returns the selling settings object.

GET /api/crm/selling-settings 
curl https://api.overplane.dev/api/crm/selling-settings \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "selling-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "cust_master_name": "Customer Name",
  "customer_group": "customer_group_example",
  "territory": "territory_example",
  "selling_price_list": "selling_price_list_example",
  "so_required": "so_required_example",
  "dn_required": "dn_required_example",
  "sales_update_frequency": "Daily",
  "maintain_same_sales_rate": false,
  "editable_price_list_rate": false,
  "allow_multiple_items": false,
  "allow_against_multiple_purchase_orders": false,
  "validate_selling_price": false,
  "hide_tax_id": false,
  "maintain_same_rate_action": "Stop",
  "role_to_override_stop_action": "role_to_override_stop_action_example",
  "editable_bundle_item_rates": false,
  "enable_discount_accounting": false,
  "allow_sales_order_creation_for_expired_quotation": false,
  "dont_reserve_sales_order_qty_on_sales_return": false,
  "allow_negative_rates_for_items": false,
  "blanket_order_allowance": 0,
  "enable_cutoff_date_on_bulk_delivery_note_creation": false,
  "allow_zero_qty_in_sales_order": false,
  "allow_zero_qty_in_quotation": false,
  "allow_delivery_of_overproduced_qty": false,
  "fallback_to_default_price_list": false,
  "use_legacy_js_reactivity": false,
  "set_zero_rate_for_expired_batch": false,
  "enable_tracking_sales_commissions": false,
  "enable_utm": false,
  "deliver_secondary_items": false
}
PATCH /api/crm/selling-settings/{id}

Update a selling settings

Updates the specified selling settings by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the selling settings to update.

Body parameters

cust_master_name string

Default: Customer Name

customer_group string
territory string
selling_price_list string
so_required string
dn_required string
sales_update_frequency string

Default: Daily

maintain_same_sales_rate boolean

Default: false

editable_price_list_rate boolean

Default: false

allow_multiple_items boolean

Default: false

allow_against_multiple_purchase_orders boolean

Default: false

validate_selling_price boolean

Default: false

hide_tax_id boolean

Default: false

maintain_same_rate_action string

Default: Stop

role_to_override_stop_action string
editable_bundle_item_rates boolean

Default: false

enable_discount_accounting boolean

Default: false

allow_sales_order_creation_for_expired_quotation boolean

Default: false

dont_reserve_sales_order_qty_on_sales_return boolean

Default: false

allow_negative_rates_for_items boolean

Default: false

blanket_order_allowance number
enable_cutoff_date_on_bulk_delivery_note_creation boolean

Default: false

allow_zero_qty_in_sales_order boolean

Default: false

allow_zero_qty_in_quotation boolean

Default: false

allow_delivery_of_overproduced_qty boolean

Default: false

fallback_to_default_price_list boolean

Default: false

use_legacy_js_reactivity boolean

Default: false

set_zero_rate_for_expired_batch boolean

Default: false

enable_tracking_sales_commissions boolean

Default: false

enable_utm boolean

Default: false

deliver_secondary_items boolean

Default: false

Returns

Returns the updated selling settings object.

PATCH /api/crm/selling-settings/{id} 
curl https://api.overplane.dev/api/crm/selling-settings/selling-settings_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"cust_master_name":"Customer Name","customer_group":"customer_group_example"}'
Response 
{
  "id": "selling-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "cust_master_name": "Customer Name",
  "customer_group": "customer_group_example",
  "territory": "territory_example",
  "selling_price_list": "selling_price_list_example",
  "so_required": "so_required_example",
  "dn_required": "dn_required_example",
  "sales_update_frequency": "Daily",
  "maintain_same_sales_rate": false,
  "editable_price_list_rate": false,
  "allow_multiple_items": false,
  "allow_against_multiple_purchase_orders": false,
  "validate_selling_price": false,
  "hide_tax_id": false,
  "maintain_same_rate_action": "Stop",
  "role_to_override_stop_action": "role_to_override_stop_action_example",
  "editable_bundle_item_rates": false,
  "enable_discount_accounting": false,
  "allow_sales_order_creation_for_expired_quotation": false,
  "dont_reserve_sales_order_qty_on_sales_return": false,
  "allow_negative_rates_for_items": false,
  "blanket_order_allowance": 0,
  "enable_cutoff_date_on_bulk_delivery_note_creation": false,
  "allow_zero_qty_in_sales_order": false,
  "allow_zero_qty_in_quotation": false,
  "allow_delivery_of_overproduced_qty": false,
  "fallback_to_default_price_list": false,
  "use_legacy_js_reactivity": false,
  "set_zero_rate_for_expired_batch": false,
  "enable_tracking_sales_commissions": false,
  "enable_utm": false,
  "deliver_secondary_items": false
}