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

Budget routes: create, get, list

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

Reference for Budget, one group of Budget routes.

Budget.create

Creates a Budget. Verb page.

Text
POST /{namespace}/budgets

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

Inputs

InputTypeRequiredDescription
accountstringrequiredThe chart-of-accounts code it plans, such as expense.ads.
periodPeriodrequiredThe Period it plans.
amountmoneyrequiredThe amount set for the account in the Period.

Returns

OutputTypeRequiredDescription
budgetBudgetrequiredThe Budget.

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/budgets \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account":"expense.ads","period":"period_VEVuYACTsH","amount":{"amount":29,"currency":"USD"}}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "budget": {
    "$id": "https://api.sb/leaseline.app/budgets/budget_qnCdsFGLVN",
    "$type": "Budget",
    "account": "expense.ads",
    "period": "period_VEVuYACTsH",
    "amount": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Budget.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Budget.get

Returns one Budget by id. Verb page.

Text
GET /{namespace}/budgets/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
budgetBudgetrequiredThe Budget.

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/budgets/budget_qnCdsFGLVN \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Budget",
  "$id": "https://api.sb/leaseline.app/budgets/budget_qnCdsFGLVN",
  "budget": {
    "$id": "https://api.sb/leaseline.app/budgets/budget_qnCdsFGLVN",
    "$type": "Budget",
    "account": "expense.ads",
    "period": "period_VEVuYACTsH",
    "amount": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "links": {
    "self": "https://api.sb/leaseline.app/budgets/budget_qnCdsFGLVN",
    "up": "https://api.sb/leaseline.app/budgets"
  }
}

Budget.list

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

Text
GET /{namespace}/budgets

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
budgetslist of BudgetrequiredOne page of Budgets.

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/budgets?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Budget",
  "budgets": [
    {
      "$id": "https://api.sb/leaseline.app/budgets/budget_qnCdsFGLVN",
      "$type": "Budget",
      "account": "expense.ads",
      "period": "period_VEVuYACTsH",
      "amount": {
        "amount": 29,
        "currency": "USD"
      }
    }
  ],
  "meta": {
    "limit": 20,
    "after": "budget_qnCdsFGLVN"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/budgets?limit=20",
    "next": "https://api.sb/leaseline.app/budgets?after=budget_qnCdsFGLVN"
  }
}

Budget

Previous

update, delete

Next