Skip to content

Bill routes: update

The Bill Verbs update as api.sb routes, with inputs, result, refusals and an example.

Reference for Bill, one group of Bill routes.

Bill.update

Changes the given properties of a Bill. Verb page.

Text
PATCH /{namespace}/bills/{id}

Path: id. Body, as JSON: the other inputs. Emits Bill.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Bill.
organizationOrganizationThe Organization the Startup owes.
amountmoneyWhat the Bill asks for, in its currency.
dueOndateThe date payment is due; an approved Bill is paid on it.
accountstringThe chart-of-accounts code it is coded to, such as expense.hosting.
fileFileThe File the Bill arrived as: an email attachment or an upload.

Returns

OutputTypeRequiredDescription
billBillrequiredThe Bill.

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 PATCH https://api.sb/leaseline.app/bills/bill_Zorj7Zkbtc \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"organization":"organization_v0SkRLrXCN"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "bill": {
    "$id": "https://api.sb/leaseline.app/bills/bill_Zorj7Zkbtc",
    "$type": "Bill",
    "organization": "organization_v0SkRLrXCN",
    "amount": {
      "amount": 29,
      "currency": "USD"
    },
    "dueOn": "2026-10-22",
    "status": "received"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Bill.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}