Productive icon

Productive

Interact with the Productive API

Actions508

Invoices → Preview invoice

AI-generated

Summary

Generate a preview of an invoice based on specified criteria without creating the actual invoice.

Inputs

  • Sent On ID — The sent on ID of the resource to preview.
  • Budget IDs — Array of budget IDs to include in the invoice preview.
  • Invoicing Method — Sets the invoicing method; valid values are 'uninvoiced_time_and_expenses', 'uninvoiced_amount', or 'percentage'.
  • Invoicing By — Determines invoicing by service or budget; required if invoicing method is 'uninvoiced_amount' or 'percentage'.
  • Percentage (required) — The percentage of budget revenue to invoice; required if invoicing method is 'percentage'.
  • Display Format — The display format for the invoice preview.
  • Expense Display Format — Display format specifically for expenses in the invoice preview.
  • Locale — Locale setting; required if invoicing method is 'uninvoiced_time_and_expenses'.
  • Date From — Start date filter to limit invoicing preview to a range.
  • Date To — End date filter to limit invoicing preview to a range.

Output shape

a single JSON object containing the invoice preview details as returned by the Productive API.

The output provides a detailed preview of what the invoice would look like based on inputs; it does not create or send an invoice. Errors are returned in the output JSON under an error property if operation fails and continueOnFail is enabled.

Examples

Example 1: Preview invoice for uninvoiced time and expenses between two dates for specific budgets.

Set Invoicing Method to 'uninvoiced_time_and_expenses', provide Budget IDs, Date From, Date To, and Locale.

Discussion