Manage invoices
invoices_manageInvoices. save_draft (create, or edit by id), issue (numbers it; final), send (emails it; confirm), void, public_link (a pay link; revoke), credit_note (amount + reason; final), send_credit_note / void_credit_note (creditNoteId), recurring (frequency + nextRunDate, autoSend emails each; stop). Confirm anything final or sent.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Required for: issue, send, void, public_link, credit_note, recurring; optional for: save_draft. Edit this draft. | |
| to | No | Default: profile billing email, then the contact's email. | |
| stop | No | recurring: end the schedule. | |
| lines | No | itemId (saved item) or name + unitPrice. Decimal strings. taxIds: which of the taxes apply (default all). | |
| notes | No | ||
| taxes | No | [{id?,name,rate}], e.g. GST 5 + QST 9.975 (ids t1,t2…). | |
| terms | No | ||
| action | Yes | ||
| amount | No | credit_note: before tax, e.g. "50.00". | |
| reason | No | credit_note: printed on it. | |
| revoke | No | public_link: turn the link off. | |
| charges | No | Below the subtotal (shipping); negative for a discount or deposit. | |
| dueDate | No | YYYY-MM-DD. Default from profile terms. | |
| endDate | No | recurring: YYYY-MM-DD, or omit for no end. | |
| message | No | A note above the invoice in the email. | |
| sendVia | No | Default: their own mailbox, then Resend, then Groundbase's address. | |
| subject | No | Default: the invoice settings subject. | |
| taxRate | No | credit_note: percent, e.g. "13". | |
| autoSend | No | recurring: email each copy to the customer. Confirm with the user. | |
| currency | No | ISO 4217. Defaults from the billing profile. | |
| companyId | No | ||
| contactId | No | Create: one of contactId/companyId. | |
| frequency | No | ||
| issueDate | No | YYYY-MM-DD. Default today. | |
| nextRunDate | No | recurring: YYYY-MM-DD, today or later. | |
| confirm_paid | No | Void even though payments or credit notes are recorded on it. Only after the user has confirmed. Default false. | |
| creditNoteId | No | Required for: send_credit_note, void_credit_note. |