Skip to content

by Startups.Studio

Finance Invoice

Invoice.void

POST /{namespace}/invoices/{invoice}/void

Void cancels an unpaid Invoice, keeps it on record, and posts the reversing Entries.

Noun: Invoice
Mode: do
Event: Invoice.voided

You, to your agent

Void the latest invoice.

curl -X POST https://api.sb/routewise.dev/invoices/invoice_1/void \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Example reason"}'

import { $ } from 'startup-builder'

const invoice = await $.Invoice.void({ invoice: 'invoice_1', reason: 'Example reason' })

npx startup-builder do Invoice.void --json '{"invoice":"invoice_1","reason":"Example reason"}'

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

Inputs

Input	Type	Required	Description
`invoice`	Invoice	required	The unpaid Invoice.
`reason`	`text`	required	Why the amount is no longer due.

Outputs

Output	Type	Required	Description
`invoice`	Invoice	required	The voided Invoice, kept forever.

Effects

Emits Invoice.voided.
Performed by the Billing Specialist.
One-way (money, customer): it waits out its delay window, and runs in the send and do modes.

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.void
The record changed since it was read, so the write would overwrite a newer version.	`conflict`	Read the record again, then retry the write against its current state.	Invoice.void
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.void

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

Previous Page

Meter

Next Page