Skip to content

by Startups.Studio

Core grammar Entry

Entry.post

POST /{namespace}/entries/post

Post records a manual Entry pair that no Verb caused, once a second Role approves it.

Noun: Entry
Mode: do
Event: Entry.posted

You, to your agent

Post the latest entry.

curl -X POST https://api.sb/kilnbakery.com/entries/post \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"debit":"Example debit","credit":"Example credit","amount":{"amount":9,"currency":"USD"},"memo":"Example memo"}'

import { $ } from 'startup-builder'

const entry = await $.Entry.post({ debit: 'Example debit', credit: 'Example credit', amount: { amount: 9, currency: 'USD' }, memo: 'Example memo' })

npx startup-builder do Entry.post --json '{"debit":"Example debit","credit":"Example credit","amount":{"amount":9,"currency":"USD"},"memo":"Example memo"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Entry.post({ debit: 'Example debit', credit: 'Example credit', amount: { amount: 9, currency: 'USD' }, memo: 'Example memo' })"
  }
}

Inputs

Input	Type	Required	Description
`debit`	`string`	required	The account code debited, such as `expense.hosting`.
`credit`	`string`	required	The account code credited.
`amount`	`money`	required	The amount and currency.
`memo`	`text`	required	Why the Entry exists.

Outputs

Output	Type	Required	Description
`entry`	Entry	required	The debit Entry; its credit pair links to it.

Effects

Emits Entry.posted.
Performed by the Finance Lead.
One-way: it waits out its delay window, and runs in the send and do modes.
Waits for an Approval from a Role other than the one that asked.
A correction to a locked Period posts to the next open Period.

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.	Entry.post

When it waits

Gate	Default
Decision class	Medium: one-way, bounded
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Treasurer. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Entry.list

Previous Page

Entry.settle

Next Page