Skip to content

by Startups.Studio

Finance Invoice

Invoice.create

POST /{namespace}/invoices

Creates an Invoice.

Noun: Invoice
Mode: do
Event: Invoice.created

You, to your agent

Add an invoice to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/invoices \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"total":{"amount":79,"currency":"USD"},"due":"2026-10-22"}'

import { $ } from 'startup-builder'

const invoice = await $.Invoice.create({ total: { amount: 79, currency: 'USD' }, due: '2026-10-22' })

npx startup-builder do Invoice.create --json '{"total":{"amount":79,"currency":"USD"},"due":"2026-10-22"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Invoice.create({ total: { amount: 79, currency: 'USD' }, due: '2026-10-22' })"
  }
}

Create makes a new Invoice from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`total`	`money`	required	The amount due.
`due`	`date`	required	When payment is due.
`paidAt`	`datetime`		When it was paid.
`collection`	`string`		`charge` charges the saved payment method; `send` sends the Invoice and waits for a transfer. `charge` by default.
`terms`	`integer`		Days from issue until a `send` Invoice is due, such as 30; sets `due`.
`purchaseOrder`	`string`		The Customer’s purchase order number, printed on the Invoice.
`refunded`	`money`		The total returned to the Customer, from zero up to the amount paid.
`number`	`string`		The Invoice number, sequential per Startup and never reused, voided Invoices included.
`lines`	`json`		Each Offer billed: its quantity, Period and amount, with any Coupon or Credit Grant applied.
`pdf`	`url`		The Invoice, or its receipt once paid, as a PDF on the Startup’s Domain that names the seller of record.
`payUrl`	`url`		The page on the Startup’s Domain where the Customer pays it by card or bank transfer.
`subscription`	Subscription		The Invoices the Subscription issues, one for each period it renews.
`customer`	Customer		Each Invoice is owed by one Customer.

Outputs

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

Effects

Emits Invoice.created.
Two-way: try, send, do.

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.create

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`.

Invoice.collect

Previous Page

Invoice.get

Next Page