Skip to content
vocapable.Docs

Ask the business to change the quote

POST
/v1/share/{token}/changes
curl --request POST \
  --url https://api.vocapable.com/v1/share/example/changes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "message": "example", "name": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
token
required
Token
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceSharedChangeRequest
object
message
required
Message
string
>= 3 characters <= 2000 characters
name
Any of:
string
<= 200 characters
Examplegenerated
{
  "message": "example",
  "name": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceSharedQuote

What a customer sees at their link: this one version, and nothing internal.

object
state
required
State
string
Allowed values: live expired revoked superseded voided
company
required
WorkspaceSharedCompany
object
name
required
Name
string
customer_name
required
Customer Name
string
recipient_name
required
Any of:
string
version_number
required
Version Number
integer
currency
required
Currency
string
lines
required
Lines
Array<object>
WorkspaceSharedQuoteLine
object
description
required
Description
string
quantity
required
Quantity
integer
unit_amount_minor
required
Unit Amount Minor
integer
amount_minor
required
Amount Minor
integer
subtotal_minor
required
Subtotal Minor
integer
discount_minor
required
Discount Minor
integer
tax_treatment
required
Tax Treatment
string
Allowed values: not_calculated exclusive inclusive exempt
tax_minor
required
Tax Minor
integer
total_minor
required
Total Minor
integer
deposit_minor
required
Deposit Minor
integer
terms
required
Any of:
string
expires_at
required
Any of:
string format: date-time
link_expires_at
required
Link Expires At
string format: date-time
digest
required
Digest
string
prepared_at
required
Prepared At
string format: date-time
accepted_at
required
Any of:
string format: date-time
accepted_name
required
Any of:
string
changes_requested_at
required
Any of:
string format: date-time
payments
required
Payments
Array<object>
WorkspaceSharedPayment
object
kind
required
Kind
string
Allowed values: deposit full
amount_minor
required
Amount Minor
integer
currency
required
Currency
string
status
required
Status
string
Allowed values: draft approved link_created processing paid partially_paid failed refunded disputed cancelled expired
paid_minor
required
Paid Minor
integer
refunded_minor
required
Refunded Minor
integer
can_accept
required
Can Accept
boolean
can_request_changes
required
Can Request Changes
boolean
can_pay_deposit
required
Can Pay Deposit
boolean
can_pay_full
required
Can Pay Full
boolean
payment_note
required
Any of:
string
next_step
required
Next Step
string
bookable
Bookable
boolean
Example
{
  "state": "live",
  "tax_treatment": "not_calculated",
  "payments": [
    {
      "kind": "deposit",
      "status": "draft"
    }
  ],
  "bookable": false
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}