invoices_manage
Destructive
Invoices. 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
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Edit this draft. Omit to create. | |
| to | No | Default: profile billing email, then the contact's email. | |
| stop | No | recurring: end the schedule. | |
| lines | No | Line items: itemId (saved item, priced in this currency) or name + unitPrice for a one-off. Amounts are decimal strings. | |
| notes | No | ||
| 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 | Charges below the subtotal (shipping, rush fee); a negative amount for a deposit or discount. | |
| 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 |