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

Quote routes: create, get, list

The Quote Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Quote, one group of Quote routes.

Quote.create

Creates a Quote. Verb page.

Text
POST /{namespace}/quotes

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

Inputs

InputTypeRequiredDescription
totalmoneyrequiredThe quoted total.
validUntildaterequiredThe last day it may be accepted.
linesjsonrequiredOne line per Offer: quantity, list Price, discount percent, net amount, term, and start, one line per ramp year.
concessionsstring[]Concessions granted, each from the Startup’s fixed concession list, such as a 60-day termination for convenience.
paymentTermsjsonThe collection, terms and purchaseOrder every Invoice from the accepted Quote carries.
dealDealA Deal sends Quotes, each a priced proposal valid until a date.

Returns

OutputTypeRequiredDescription
quoteQuoterequiredThe 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 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"total":{"amount":29,"currency":"USD"},"validUntil":"2026-10-22","lines":{}}'
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": "draft",
    "lines": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Quote.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Quote.get

Returns one Quote by id. Verb page.

Text
GET /{namespace}/quotes/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Quote.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
quoteQuoterequiredThe 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 https://api.sb/leaseline.app/quotes/qt_GZnH5OK100 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Quote",
  "$id": "https://api.sb/leaseline.app/quotes/qt_GZnH5OK100",
  "quote": {
    "$id": "https://api.sb/leaseline.app/quotes/qt_GZnH5OK100",
    "$type": "Quote",
    "total": {
      "amount": 29,
      "currency": "USD"
    },
    "validUntil": "2026-10-22",
    "status": "draft",
    "lines": {}
  },
  "links": {
    "self": "https://api.sb/leaseline.app/quotes/qt_GZnH5OK100",
    "up": "https://api.sb/leaseline.app/quotes"
  },
  "actions": {
    "accept": "https://api.sb/leaseline.app/quotes/qt_GZnH5OK100/accept",
    "decline": "https://api.sb/leaseline.app/quotes/qt_GZnH5OK100/decline",
    "expire": "https://api.sb/leaseline.app/quotes/qt_GZnH5OK100/expire"
  }
}

Quote.list

Returns Quotes, newest first, one page at a time. Verb page.

Text
GET /{namespace}/quotes

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
quoteslist of QuoterequiredOne page of Quotes.

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 "https://api.sb/leaseline.app/quotes?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Quote",
  "quotes": [
    {
      "$id": "https://api.sb/leaseline.app/quotes/qt_GZnH5OK100",
      "$type": "Quote",
      "total": {
        "amount": 29,
        "currency": "USD"
      },
      "validUntil": "2026-10-22",
      "status": "draft",
      "lines": {}
    }
  ],
  "meta": {
    "limit": 20,
    "after": "qt_GZnH5OK100"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/quotes?limit=20",
    "next": "https://api.sb/leaseline.app/quotes?after=qt_GZnH5OK100"
  }
}

Quote

Previous

update, delete

Next