Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIFinanceQuote

Quote routes: request, send, supersede

The Quote Verbs request, send, supersede as api.sb routes, with inputs, result, refusals and an example.

Reference for Quote, one group of Quote routes.

Quote.request

Request asks a Startup for terms on one or more Offers, with the volume, term or scope wanted. Verb page.

Text
POST /{namespace}/quotes/request

Body, as JSON: the inputs. Emits Quote.requested.

Inputs

InputTypeRequiredDescription
offerslist of OfferrequiredThe Offers wanted.
dealDealThe open Deal the terms are for; without one, a new Deal opens.
volumeintegerUnits wanted, such as seats or calls a month.
termstringContract length wanted, such as 12 months.
briefjsonA Service buyer’s scope, sizes and due dates, such as 82,000 words in three weeks.

Returns

OutputTypeRequiredDescription
dealDealrequiredThe Deal, waiting on a Quote.
quoteQuoterequiredThe Quote requested, in draft.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
An Offer that is not open to the requesting party, such as one behind a WaitlistrefusedClear what the check names, then call it again.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/quotes/request \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"offers":["offer_2hzYe1ERo0"]}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "deal": {
    "$id": "https://api.sb/leaseline.app/deals/deal_NgACZ6DcII",
    "$type": "Deal",
    "status": "Open"
  },
  "quote": {
    "$id": "https://api.sb/leaseline.app/quotes/qt_GZnH5OK100",
    "$type": "Quote",
    "total": {
      "amount": 29,
      "currency": "USD"
    },
    "validUntil": "2026-10-22",
    "status": "draft",
    "lines": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Quote.request",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Quote.send

Send presents a drafted Quote to its buyer and freezes its lines, total and payment terms. Verb page.

Text
POST /{namespace}/quotes/{quote}/send

Path: quote. Emits Quote.sent.

Inputs

InputTypeRequiredDescription
quoteQuoterequiredThe draft Quote.

Returns

OutputTypeRequiredDescription
quoteQuoterequiredThe sent Quote.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/quotes/qt_GZnH5OK100/send \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "quote": {
    "$id": "https://api.sb/leaseline.app/quotes/qt_GZnH5OK100",
    "$type": "Quote",
    "total": {
      "amount": 29,
      "currency": "USD"
    },
    "validUntil": "2026-10-22",
    "status": "sent",
    "lines": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Quote.send",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Quote.supersede

Supersede replaces a sent Quote with a newer one on the same Deal; only the newest Quote can be accepted. Verb page.

Text
POST /{namespace}/quotes/{quote}/supersede

Path: quote. Body, as JSON: the other inputs. Emits Quote.superseded.

Inputs

InputTypeRequiredDescription
quoteQuoterequiredThe Quote being replaced.
byQuoterequiredThe newer Quote that replaces it.

Returns

OutputTypeRequiredDescription
quoteQuoterequiredThe superseded Quote, kept on record.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/quotes/qt_GZnH5OK100/supersede \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"by":"qt_GZnH5OK100"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "quote": {
    "$id": "https://api.sb/leaseline.app/quotes/qt_GZnH5OK100",
    "$type": "Quote",
    "total": {
      "amount": 29,
      "currency": "USD"
    },
    "validUntil": "2026-10-22",
    "status": "superseded",
    "lines": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Quote.supersede",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

accept, decline, expire

Previous

Share

Next