Skip to content

by Startups.Studio

Finance Invoice

Invoice.bill

POST /{namespace}/invoices/{invoice}/bill

Bill finalizes an Invoice and presents it to the Customer for payment.

Noun: Invoice
Mode: do
Event: Invoice.billed

You, to your agent

Bill the latest invoice.

curl -X POST https://api.sb/tutorloop.com/invoices/invoice_1/bill \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

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

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

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

Inputs

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

Outputs

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

Effects

Emits Invoice.billed.
Performed by the Billing Specialist.
One-way (customer): it waits out its delay window, and runs in the send and do modes.
Freezes the Invoice’s lines; a correction is a credit, never an edit.

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.	Invoice.bill
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.bill

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (customer)
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 Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Invoice

Previous Page

Invoice.collect

Next Page