Invoices

Voids an invoice.

Requires ManageInvoices and an Idempotency-Key header. Same rules as the Void button: only a finalized invoice with no recorded payments can be voided (delete or refund its payments first); a draft is not voided but deleted (DELETE /api/v1/invoices/{id}); a consolidated invoice is voided as a whole, not through its members. Applied store credit is handed back to the customer and the job's payment status is recalculated. Voiding is permanent — the invoice stays visible with status Cancelled. The body is optional.

post/api/v1/invoices/{id}/void

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/invoices/{id}/void
  • Auth: HTTP bearer

Path parameters

idinteger required

Numeric invoice id.

Request body

reasonstring nullable

Why the invoice is being voided. Recorded in the job's history when the invoice bills a job.

Response

The voided invoice (status Cancelled).

idinteger

Numeric id, usable in /api/v1/invoices/{id}.

syncIdstring uuid

Stable cross-device id; also the pagination cursor.

invoiceNumberstring

Human-readable invoice number, e.g. INV-1042.

status'Draft' | 'Sent' | 'Viewed' | 'PartiallyPaid' | 'Paid' | 'Overdue' | 'Cancelled' | 'Outstanding' | 'Consolidated'
customerIdinteger nullable

Billed customer id, if any.

customerNamestring nullable

Billed customer name, if any.

jobIdinteger nullable

Job the invoice bills, if any.

jobNumberstring nullable

Job number, if any.

salesOrderIdinteger nullable

Sales order the invoice bills, if any.

descriptionstring nullable

Optional description.

invoiceDatestring date-time

Issue date, ISO-8601 UTC at midnight, e.g. 2026-09-05T00:00:00Z.

dueDatestring date-time

Due date, ISO-8601 UTC at midnight, e.g. 2026-10-05T00:00:00Z.

subtotalnumber double

Sum of lines before tax.

taxAmountnumber double

Tax charged.

totalnumber double

Subtotal plus tax.

amountPaidnumber double

Payments applied.

storeCreditAppliednumber double

Store credit applied.

balanceDuenumber double

Total minus payments and store credit.

isConsolidatedboolean

True when this invoice consolidates other invoices.

consolidatedIntoInvoiceIdinteger nullable

Id of the consolidated invoice that absorbed this one, if any.

sentDatestring date-time nullable

When the invoice was first sent, ISO-8601 UTC (e.g. 2026-09-05T14:30:00Z); null if never sent.

paidDatestring date-time nullable

When the invoice was paid in full, ISO-8601 UTC; null until paid.

createdAtstring date-time

Creation time, ISO-8601 UTC.

updatedAtstring date-time nullable

Last modification time, ISO-8601 UTC; null when never edited. Use with the updatedSince filter to poll for changes.

Changes

No recorded changes to this operation across all 1 revision of this API.