Skip to content

Bill methods: update

The Bill Verbs update as typed SDK methods, with inputs, result, refusals and an example.

Reference for Bill, one group of Bill methods.

Bill.update

Changes the given properties of a Bill. Verb page.

TypeScript
interface BillVerbs {
  update(input: BillUpdateInput, options?: SB.CallOptions): SB.Call<Bill>
}

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

TypeScript
import { $ } from 'startup-builder'

const bill = await $.Bill.update({ id: 'bill_Zorj7Zkbtc', organization: 'organization_v0SkRLrXCN' })