PUT /public/v1/documents/{document_id}/quotes/{quote_id}

This operation updates the details of a specific quote within a document by specifying the document ID and quote ID.

Servers

Path parameters

Name Type Required Description
document_id String Yes

Document ID

quote_id String Yes

Quote ID

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
sections[] Array No

Quote sections - this property overrides existing sections in the specified order. If you want to change only one section, you must still pass other sections IDs. Otherwise these sections will be removed.

sections[].id String No

Section ID to update. Invalid (or missing) ID causes creating a new section.

sections[].name String No

Name of the quotes section. If you create a section without providing a value, it will have the default value.

Default value: "Section name"

sections[].items[] Array No

Section items - this property overrides the existing items in the order specified. If you want to change only one item, you must still pass other items IDs. Otherwise these items will be removed.

sections[].items[].price Number No

Item price. If you create an item without providing a value, it will have the default value. If price_settings is passed, this value may change after the quote is updated.

Default value: 0

sections[].items[].discounts Object No

Item discounts.

sections[].items[].discounts.name Object No
sections[].items[].discounts.name.type String No

Valid values:

  • "flat"
  • "percent"
sections[].items[].discounts.name.value Number No
sections[].items[].description String No

Item description. If you create an item without providing a value, it will have the default value.

sections[].items[].billing_frequency String No

Valid values:

  • "semiannualy"
  • "monthly"
  • "weekly"
  • "annually"
  • "quarterly"
sections[].items[].qty Integer No

Item QTY. If you create an item without providing a value, it will have the default value.

Default value: 1

sections[].items[].external_columns Object No
sections[].items[].cost Number No

Item cost. If you create an item without providing a value, it will have the default value.

sections[].items[].fees Object No

Item fees.

sections[].items[].fees.name Object No
sections[].items[].fees.name.type String No

Valid values:

  • "flat"
  • "percent"
sections[].items[].fees.name.value Number No
sections[].items[].reference_id String No

Use this field to pass an id that references this item in external systems.

sections[].items[].multipliers Object No

Item multipliers.

sections[].items[].id String No

Item ID to update. Invalid (or missing) ID causes creating a new item.

sections[].items[].sku String No

Product SKU. If you create an item without providing a value, it will have the default value.

Default value: "#"

sections[].items[].name String No

Item name. If you create an item without providing a value, it will have the default value.

sections[].items[].text_columns Object No
sections[].items[].options Object No

Denotes whether an item is selected, optional, and has editable quantity.

sections[].items[].options.selected Boolean No

Default value: true

sections[].items[].options.qty_editable Boolean Yes

Default value: true

sections[].items[].options.optional Boolean No

Default value: false

sections[].items[].contract_term Integer No

Contract term. Measured in units set in the billing_frequency parameter.

sections[].items[].price_settings Object No

Price settings if the price is not flat rate. If it is null, the price is flat rate.

sections[].items[].price_settings.tiers[] Array Yes
sections[].items[].price_settings.tiers[].min_qty Integer Yes
sections[].items[].price_settings.tiers[].value Number Yes
sections[].items[].price_settings.base_value Number Yes

Base value for volume discount pricing. If set, tiers are treated like percentage of discount on this value. If not set, tiers are treated like a flat value discount of chosen currency.

sections[].items[].taxes Object No

Item taxes.

sections[].items[].taxes.name Object No
sections[].items[].taxes.name.type String No

Valid values:

  • "flat"
  • "percent"
sections[].items[].taxes.name.value Number No
sections[].items[].custom_columns Object No
sections[].settings Object No

Section settings. Denotes whether a section is optional or selected, and selection type inside the section - single, multiple, or custom.

sections[].settings.selected Boolean No
sections[].settings.optional Boolean No
sections[].settings.selection_type String No

Valid values:

  • "single"
  • "custom"
  • "multiple"
sections[].summary Object No

Summary settings containing adjustments (discounts, fees, taxes) and custom columns that apply to the entire quote / section total.

sections[].summary.discounts Object No

Summary level discounts.

sections[].summary.discounts.name Object No
sections[].summary.discounts.name.type String No

Valid values:

  • "flat"
  • "percent"
sections[].summary.discounts.name.value Number No
sections[].summary.fees Object No

Summary level fees.

sections[].summary.fees.name Object No
sections[].summary.fees.name.type String No

Valid values:

  • "flat"
  • "percent"
sections[].summary.fees.name.value Number No
sections[].summary.taxes Object No

Summary level taxes.

sections[].summary.taxes.name Object No
sections[].summary.taxes.name.type String No

Valid values:

  • "flat"
  • "percent"
sections[].summary.taxes.name.value Number No
sections[].summary.custom_columns Object No
settings Object No

Quote settings. Denotes whether a quote is optional or selected, and selection type inside the section - single, multiple, or custom.

settings.selection_type String No

Valid values:

  • "single"
  • "custom"
  • "multiple"
currency String No

Currency code (ISO 4217)

summary Object No

Summary settings containing adjustments (discounts, fees, taxes) and custom columns that apply to the entire quote / section total.

summary.discounts Object No

Summary level discounts.

summary.discounts.name Object No
summary.discounts.name.type String No

Valid values:

  • "flat"
  • "percent"
summary.discounts.name.value Number No
summary.fees Object No

Summary level fees.

summary.fees.name Object No
summary.fees.name.type String No

Valid values:

  • "flat"
  • "percent"
summary.fees.name.value Number No
summary.taxes Object No

Summary level taxes.

summary.taxes.name Object No
summary.taxes.name.type String No

Valid values:

  • "flat"
  • "percent"
summary.taxes.name.value Number No
summary.custom_columns Object No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.