PApandadoc
Quotes

Quote update

Changed on

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

📘 Permissions

Requires the 'Can Edit Document' and 'Can Edit Content' permissions. The document must be in Draft (document.draft). Updating quotes is available on plans that include Product Catalog.

🚧 Payload size

The maximum request body size is 512 KiB (524288 bytes). Larger requests return 413 and are not applied.

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

Request

Path parameters

document_idstring required

Document ID

quote_idstring required

Quote ID

Request body

currencystring

Currency code (ISO 4217)

Example request

{
  "currency": "USD",
  "sections": [
    {
      "items": [
        {
          "qty": 10,
          "price": 42.42,
          "cost": 42.42
        }
      ]
    }
  ]
}

Response

OK

idstring
currencystring
totalstring

Example response

{
  "id": "4b011d86-286b-4f86-b697-90a6ad3f1489",
  "currency": "USD",
  "total": "900",
  "summary": {
    "total": "900",
    "subtotal": "1000",
    "one_time_subtotal": "500",
    "recurring_subtotal": [
      {
        "billing_cycle": "monthly",
        "value": "500"
      }
    ],
    "total_discount": "100",
    "total_contract_value": "1900"
  },
  "sections": [
    {
      "summary": {
        "total": "1000",
        "subtotal": "1000",
        "one_time_subtotal": "500",
        "recurring_subtotal": [
          {
            "billing_cycle": "monthly",
            "value": "500"
          }
        ],
        "total_section_value": "1900"
      },
      "items": [
        {
          "qty": "1",
          "price": "500",
          "overall_total": "1000"
        }
      ],
      "total": "1000"
    }
  ]
}

Changes

  • b9a306b1a421Revision changes
    • breaking

      removed the enum value semiannualy of the request property ////

    • breaking

      the //// response's property type changed from string to boolean for status

    • warning

      added the new annually enum value to the //// response property for the response status

    • warning

      added the new monthly enum value to the //// response property for the response status

    • warning

      added the new quarterly enum value to the //// response property for the response status

    • warning

      added the new semiannually enum value to the //// response property for the response status

    • warning

      added the new weekly enum value to the //// response property for the response status

    • info

      added the new optional request property //

    • info

      added the new semiannually enum value to the request property ////

    • info

      added the non-success response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status