basalt / subscriptions/src / Invoices
Class: Invoices
Defined in: subscriptions/src/invoice.ts:204
Constructors
Constructor
> new Invoices(options?): Invoices
Defined in: subscriptions/src/invoice.ts:211
Parameters
options?
InvoicesOptions = {}
Returns
Invoices
Methods
addLine()
> addLine(id, line): Promise<Invoice>
Defined in: subscriptions/src/invoice.ts:267
Append a line to a draft and recompute.
Parameters
id
string
line
Returns
Promise<Invoice>
draft()
> draft(input): Promise<Invoice>
Defined in: subscriptions/src/invoice.ts:220
Create a draft invoice with computed totals. No number is assigned yet.
Parameters
input
Returns
Promise<Invoice>
finalize()
> finalize(id): Promise<Invoice>
Defined in: subscriptions/src/invoice.ts:277
Finalize a draft → open, assigning the sequential invoice number.
Parameters
id
string
Returns
Promise<Invoice>
get()
> get(id): Promise<Invoice | null>
Defined in: subscriptions/src/invoice.ts:318
Parameters
id
string
Returns
Promise<Invoice | null>
list()
> list(billableId): Promise<Invoice[]>
Defined in: subscriptions/src/invoice.ts:321
Parameters
billableId
string
Returns
Promise<Invoice[]>
markPaid()
> markPaid(id, settlement?): Promise<Invoice>
Defined in: subscriptions/src/invoice.ts:289
Mark an open invoice paid. Records the settling payment reference.
Parameters
id
string
settlement?
gatewayRef?
string
paidAt?
number
paymentId?
string
Returns
Promise<Invoice>
void()
> void(id): Promise<Invoice>
Defined in: subscriptions/src/invoice.ts:306
Void a draft or open invoice (a paid one cannot be voided — refund instead).
Parameters
id
string
Returns
Promise<Invoice>