get_invoice
Fetch the full detail of a single invoice: line items, payment info, public link, QR code, stats and event timeline. Use fetch_invoices first to get the invoice_token. Requires the Invoices module enabled on the account — on a 403 "module is not enabled" error, do NOT retry; tell the user to contact Sweeppea support. Set include_events and include_qr_code to false for a lighter payload when you only need the invoice fields. The event timeline is capped at the 200 most recent events. DISPLAY RULE: never show InvoiceToken/PublicToken UUIDs; the PublicLink URL and InvoiceNumber ARE shareable.
get_invoice
When to use
Fetch the full detail of a single invoice: line items, payment info, public link, QR code, stats and event timeline. Use fetch_invoices first to get the invoice_token. Requires the Invoices module enabled on the account — on a 403 "module is not enabled" error, do NOT retry; tell the user to contact Sweeppea support. Set include_events and include_qr_code to false for a lighter payload when you only need the invoice fields. The event timeline is capped at the 200 most recent events. DISPLAY RULE: never show InvoiceToken/PublicToken UUIDs; the PublicLink URL and InvoiceNumber ARE shareable.
Parameters to validate before calling
invoice_token(string, required) — The invoice token (UUID v4). Get it via fetch_invoicesinclude_events(boolean, optional) — Include the event timeline (optional, default true). Set false for a lighter payloadinclude_qr_code(boolean, optional) — Include the QR code as a data URL (optional, default true). Set false for a lighter payload
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| invoice_token | Yes | The invoice token (UUID v4). Get it via fetch_invoices | |
| include_events | No | Include the event timeline (optional, default true). Set false for a lighter payload | |
| include_qr_code | No | Include the QR code as a data URL (optional, default true). Set false for a lighter payload |