Note: The Get Paid Invoice APIs aren't yet available for all sites. The APIs are available for new sites, and Wix is migrating existing sites. Calls for a site that Wix hasn't migrated yet fail with a 428 error. You don't need to do anything: migration enables access automatically.
The Invoice Presets API allows you to create, manage, and customize invoice presets that define the appearance, content structure, and default settings for invoices. Invoice presets control display settings, custom fields, placeholder fields, footer content, and default due dates.
With the Invoice Presets API, you can:
- Create and manage invoice presets with custom display settings and formatting options.
- Add custom fields for headers, business details, and customer information sections.
- Define placeholder fields that appear as blank titled fields on the invoice for the recipient to fill in.
- Set a default invoice preset that's automatically applied when new invoices are created.
- Control which business and customer details are shown or hidden on invoices.
It's important to note the following points before starting to code:
- Invoice presets define the template structure but don't contain actual invoice data.
- Each site always has at least 1 invoice preset, with 1 designated as the default. A site can have a maximum of 10 presets.
- When you create an invoice without specifying a preset, the default preset is applied to the invoice's appearance and field layout.
- The default preset can't be deleted. To delete it, first assign a different preset as the default using Set Default Invoice Preset.
When you update a preset, the changes affect new invoices and existing draft invoices that use the preset. Invoices that have already been published aren't affected by preset updates.
The customFields.footerCustomField field accepts rich content for the invoice footer, but only a subset of the rich content format is supported: text formatting and images.
When you update an invoice preset via the API, the changes are reflected immediately in the Wix dashboard invoice creation flow. Wix users can also manage presets manually from Invoices > Settings > Invoice Customization in the Wix dashboard.
- Invoice: A document that records goods or services provided to a customer, including itemized amounts and payment details.
- Invoice preset: A reusable template that defines the appearance, content structure, and default settings for invoices.
- Default preset: The preset automatically applied when new invoices are created on the site.
- Placeholder field: A titled blank field that appears on the invoice for the recipient to fill in.