Bill methods: create, get, list
The Bill Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.
Reference for Bill, one group of Bill methods.
Bill.create
Creates a Bill. Verb page.
interface BillVerbs {
create(input: BillCreateInput, options?: SB.CallOptions): SB.Call<Bill>
}Emits Bill.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
organization | Organization | required | The Organization the Startup owes. |
amount | money | required | What the Bill asks for, in its currency. |
dueOn | date | required | The date payment is due; an approved Bill is paid on it. |
account | string | The chart-of-accounts code it is coded to, such as expense.hosting. | |
file | File | The File the Bill arrived as: an email attachment or an upload. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
bill | Bill | required | The Bill. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const bill = await $.Bill.create({ organization: 'organization_v0SkRLrXCN', amount: { amount: 29, currency: 'USD' }, dueOn: '2026-10-22' })Bill.get
Returns one Bill by id. Verb page.
interface BillVerbs {
get(input: BillGetInput, options?: SB.CallOptions): SB.Call<Bill>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Bill. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
bill | Bill | required | The Bill. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const bill = await $.Bill.get({ id: 'bill_Zorj7Zkbtc' })Bill.list
Returns Bills, newest first, one page at a time. Verb page.
interface BillVerbs {
list(input?: BillListInput, options?: SB.CallOptions): SB.ListCall<Bill>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
bills | list of Bill | required | One page of Bills. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const bills = await $.Bill.list({ limit: 20 })