Create invoice
create_invoiceCreates a draft invoice or estimate, with its lines if given, copying the user's billing details and the chosen client onto it. The draft is private: nothing is sent or published. It has no number until it is sent; sending takes the next one from the profile's counter. The free plan includes 2 invoices or estimates per calendar month (voided ones count); Pro has no limit. Needs the billing details to be set up.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| lines | No | At most 500. | |
| notes | No | Up to 4000 characters. Default: the profile's default notes. | |
| terms | No | Up to 4000 characters. Default: the profile's payment instructions. | |
| toName | No | Who it is for. Default: the client's name. | |
| boardId | No | A project the user owns, to link the document to. | |
| dueDate | No | YYYY-MM-DD. Default: the profile's payment terms (invoice) or 30 days (estimate). | |
| toEmail | No | ||
| toTaxId | No | ||
| clientId | No | One of the user's clients; its name, email, address, tax id and currency are copied onto the document. | |
| currency | No | Three-letter code. Default: the client's, else the profile's. | |
| discount | No | A fixed amount off the whole document. An amount in the currency's main unit, e.g. 85 or "85.50" (not cents). null clears it. | |
| taxLabel | No | What the tax is called, up to 30 characters. | |
| issueDate | No | The issue date. Default today, YYYY-MM-DD. | |
| toAddress | No | ||
| taxPercent | No | Tax as a percentage, e.g. 21 or "10,5". Default: the profile's. |