Sign in
Invoice

DRY RUN: computes the line items that AddUninvoicedItems would create for the given filters - quantities, blended rates, converted expense amounts with markup, generated descriptions, taxes, and the source record IDs each line covers - WITHOUT saving anything or marking any record as invoiced. Use it to answer "what is ready to bill onto this invoice?" and to confirm with a person before calling AddUninvoicedItems.

post/api/Invoice/PreviewUninvoicedItems

Request body

InvoiceIDinteger required

The Transaction ID of the invoice whose customer's uninvoiced records should be selected. The invoice must not be Void.

SendWebhooksboolean

If true (add only; ignored by preview), fires invoice_updated plus timesheet_updated/expense_updated webhook events for linked records. Defaults to false.

Response

Returns the computed line items and totals. An empty LineItems list means nothing is currently ready to bill for the filters.

SubtotalAmountnumber double

Sum of the previewed line amounts.

TaxAmountnumber double

Sum of the previewed line tax amounts.

TotalAmountnumber double

The total the previewed lines would add to the invoice.

SkippedTimesheetEntryIDsinteger[]

Timesheet entries that matched the filters but were skipped because they have a running timer.

Warningsstring[]

Non-fatal notices about the preview.

Changes

Changed in 1 of the 3 revisions of this API.1