Invoices

Create

Minimal invoice with inline customer and one line item:

Create minimaltypescript

Copy

// title: Minimal invoice
const invoice = await sdk.invoices.create({
  customer: { name: "Acme Corp" },
  items: [{ name: "Service", quantity: 1, price: 100 }],
});

Create Invoice API →

Or reference saved data:

Create with refstypescript

Copy

// title: Invoice with saved references
const invoice = await sdk.invoices.create({
  customer_id: "cus_abc123",
  items: [
    { item_id: "itm_xyz789", quantity: 5 },
    { name: "Custom service", quantity: 1, price: 250 },
  ],
});

Finalize

Finalize to assign an invoice number and lock the document:

Finalizetypescript

Copy

// title: Finalize invoice
// Finalize assigns a document number and locks the invoice
const finalized = await sdk.invoices.finalize(invoice.id);

console.log(finalized.number); // __PROTECTED_0__
console.log(finalized.status); // __PROTECTED_1__

Finalize API →

Or pass draft: false when creating to finalize immediately.

Download PDF

Render pdftypescript

Copy

// title: Render PDF
const pdf = await sdk.invoices.renderPdf(invoice.id);

// Save to file
fs.writeFileSync("invoice.pdf", pdf);

// Or send as response
res.setHeader("Content-Type", "application/pdf");
res.send(pdf);

Render PDF API →

Send by Email

Send emailtypescript

Copy

// title: Send invoice
await sdk.email.send(invoice.id, {
  to: invoice.customer.email,
  subject: "Your invoice #{document_number}",
  body: "Thank you for your business!",
});

Email API →

Uses the entity’s default email template. See Email API for custom subject/body.

Other Document Types

Same patterns apply to:

• Estimates — Quotes
• Credit Notes — Refunds
• Advance Invoices — Prepayments