Skip to content

by Startups.Studio

Finance Transaction

Transaction.categorize

POST /{namespace}/transactions/{transaction}/categorize

Categorize codes a Transaction to an account in the chart by the Startup’s Policy and flags a low-confidence code for review.

Noun: Transaction
Mode: do
Event: Transaction.categorized

You, to your agent

Categorize the latest transaction.

curl -X POST https://api.sb/ledgerlark.com/transactions/transaction_1/categorize \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const { transaction, account, confidence } = await $.Transaction.categorize({ transaction: 'transaction_1' })

npx startup-builder do Transaction.categorize --json '{"transaction":"transaction_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Transaction.categorize({ transaction: 'transaction_1' })"
  }
}

Inputs

Input	Type	Required	Description
`transaction`	Transaction	required	The Transaction to code.
`account`	`string`		The account code to use in place of the Policy’s choice.

Outputs

Output	Type	Required	Description
`transaction`	Transaction	required	The coded Transaction.
`account`	`string`	required	The account code it was coded to.
`confidence`	`number`	required	How sure the code is, from 0 to 1.

Effects

Emits Transaction.categorized.
Performed by the Finance Lead.
Two-way: it runs at once, in the try, send and do modes.
Below the Policy’s confidence threshold, opens a review Task for the Finance Lead.
A new code posts a reversing pair and a new pair; the first pair stays.

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.	Transaction.categorize

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Transaction.attach

Previous Page

Transaction.get

Next Page