Praecise Platform
Menu

Rivier/ Reference/ shop

Turn an accepted proposal into a quote (the default) or into invoices

post/proposals/{id}/convert

Turn an accepted proposal into a quote (the default) or into invoices. The proposal becomes converted.

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:write
Sdk
shop.proposal.convert
Cli
proposals convert

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • tostring
    One of: quote, invoice. Default: quote.
  • depositPercentinteger
    At least 1. At most 99.
  • idempotencyKeystring
    At most 120 characters.

Responses

  • 200application/json
    Success
    • documentobjectrequired
      • 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
    • quoteobject
      • 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
    • invoiceslist of object
      • idstring (uuid)required
      • numberstring or nullrequired
      • statusstringrequired
      • totalMinornumberrequired
      • purposestringrequired
        One of: full, deposit, balance.
  • 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

This page as Markdown