Skip to content

Entry commands: post, settle

The Entry Verbs post, settle as CLI commands, with inputs, result, refusals and an example.

Reference for Entry, one group of Entry commands.

Entry.post

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

Text
npx startup-builder do Entry.post --json '<input>' [--try | --send | --do]

Emits Entry.posted.

Inputs

InputTypeRequiredDescription
debitstringrequiredThe account code debited, such as expense.hosting.
creditstringrequiredThe account code credited.
amountmoneyrequiredThe amount and currency.
memotextrequiredWhy the Entry exists.

Returns

OutputTypeRequiredDescription
entryEntryrequiredThe debit Entry; its credit pair links to it.

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
npx startup-builder do Entry.post --json '{"debit":"Example debit","credit":"Example credit","amount":{"amount":29,"currency":"USD"},"memo":"Example memo"}'

Entry.settle

Settle nets a Period’s intercompany Entries between two Companies into one transfer through Stripe and reconciles both sides. Verb page.

Text
npx startup-builder do Entry.settle --json '<input>' [--try | --send | --do]

Emits Entry.settled.

Inputs

InputTypeRequiredDescription
periodPeriodrequiredThe closed Period whose intercompany pairs settle.
fromCompanyrequiredThe Company that owes the net amount.
toCompanyrequiredThe Company that receives it.

Returns

OutputTypeRequiredDescription
transactionTransactionrequiredThe one transfer that settles every pair.
entryEntryrequiredThe intercompany Entry, now settled.

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
npx startup-builder do Entry.settle --json '{"period":"period_VEVuYACTsH","from":"company_28zYNZEno0","to":"company_28zYNZEno0"}'