Void a proposal with the reason; it stays on record and its links stop working

Before you call

Credential

Authorization: Bearer $KEY

Scope

shop:write

Sdk

shop.proposal.void

Cli

proposals void

Parameters

• idstring (uuid)required
  In the path

Request bodyapplication/json, required

• reasonstringrequired
  At most 300 characters.

Responses

• 200application/json
  Success
  • idstring (uuid)required
  • kindstringrequired
    One of: quote, proposal.
  • organizationIdstring (uuid)required
  • clientIdstring (uuid) or nullrequired
  • numberstring or nullrequired
  • statusstringrequired
    One of: draft, sent, viewed, accepted, declined, expired, void, converted.
  • currencystringrequired
  • languagestringrequired
  • titlestringrequired
  • issueDatestring or nullrequired
  • validUntilstring or nullrequired
  • subtotalMinornumberrequired
  • taxMinornumberrequired
  • totalMinornumberrequired
  • revisionnumberrequired
  • versionnumberrequired
  • convertedKindstring or nullrequired
  • convertedIdstring (uuid) or nullrequired
  • acceptedAtstring or nullrequired
  • acceptedNamestring or nullrequired
  • declinedAtstring or nullrequired
  • sentAtstring or nullrequired
  • viewedAtstring or nullrequired
  • voidedAtstring or nullrequired
  • createdBystringrequired
  • createdAtstringrequired
  • updatedAtstringrequired
• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring