Skip to content

by Startups.Studio

Finance Invoice

Invoice.collect

POST /{namespace}/invoices/{invoice}/collect

Collect charges a Customer’s saved payment method for an open Invoice and retries on failure.

Noun: Invoice
Mode: do
Event: Invoice.collected

You, to your agent

Collect the latest invoice.

curl -X POST https://api.sb/routewise.dev/invoices/invoice_1/collect \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const invoice = await $.Invoice.collect({ invoice: 'invoice_1' })

npx startup-builder do Invoice.collect --json '{"invoice":"invoice_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Invoice.collect({ invoice: 'invoice_1' })"
  }
}

Inputs

Input	Type	Required	Description
`invoice`	Invoice	required	The open Invoice.

Outputs

Output	Type	Required	Description
`invoice`	Invoice	required	The paid Invoice.

Effects

Emits Invoice.collected.
Performed by the Billing Specialist.
One-way (money, customer): it waits out its delay window, and runs in the send and do modes.
Retries on the Startup’s retry schedule before the Invoice is marked uncollectible.
On a send Invoice, charges nothing: it records the Customer’s bank transfer when it reconciles and emits Invoice.collected then.

Refuses when

Check	Error	Fix	Then call
The operation is part of an Offer the caller has not accepted or paid for.	`payment-required`	Accept the Offer named in the response, then retry the call.	Offer.accept
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.	Invoice.collect
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Invoice.collect

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (money, customer)
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The spend Limit of the Permission or Mandate 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`.

Invoice.bill

Previous Page

Invoice.create

Next Page