Skip to navigation
API Reference

Void Invoice

Void an open or uncollectible invoice (FLU-478), as Stripe does: a draft, paid or already-void invoice is refused with Stripe’s 400, and an invoice with a payment in progress or waiting to commit is refused. Test mode only. Body is application/x-www-form-urlencoded and takes only expand. Returns the invoice.

Authentication

AuthorizationBasic

Standard Basic HTTP authentication. The username is the Fluveo secret key and the password must be empty, encoded as base64(api_key:).

OR
AuthorizationBearer

Bearer HTTP authentication. Allowed header: Authorization: Bearer <api_key>.

Path parameters

invoicestringRequiredformat: "^in_"

Headers

Idempotency-KeystringOptional1-255 characters

Makes a POST safely retryable according to that operation’s documented idempotency policy. The durable 24-hour journal applies only where the resource documentation explicitly claims it. Reusing a key with different parameters or another endpoint returns an idempotency error.

Response

Stripe-compatible response

account_countrystring or null<=5000 characters
account_namestring or null<=5000 characters
account_tax_idslist of strings or null
amount_dueinteger

Smallest currency unit (minor units / cents).

amount_overpaidinteger
amount_paidinteger

Smallest currency unit (minor units / cents).

amount_remaininginteger
amount_shippinginteger
applicationstring or null
attempt_countinteger
attemptedboolean
automatic_taxobject
automatically_finalizes_atinteger or null
billing_reasonenum or null
collection_methodenum
Allowed values:
currencystringformat: "currency"
custom_fieldslist of objects or null
customerobject or string or null
customer_accountstring or null<=5000 characters
customer_addressobject or null
customer_emailstring or null<=5000 characters
customer_namestring or null<=5000 characters
customer_phonestring or null<=5000 characters
customer_tax_exemptenum or null
Allowed values:
default_payment_methodstring or null
default_sourcestring or null
default_tax_rateslist of objects
descriptionstring or null
Merchant memo.
discountslist of strings
due_dateinteger or null

Unix timestamp (seconds); present only on send_invoice invoices that set one.

effective_atinteger or null
ending_balanceinteger or null
footerstring or null
Merchant footer.
from_invoiceobject or null
issuerobject
latest_revisionstring or null
linesobject
livemodeboolean
metadatamap from strings to strings or null
next_payment_attemptinteger or null
numberstring or null

Sequential merchant-scoped number (FLV-0001), assigned once at finalization; absent on drafts.

objectenum
Allowed values:
on_behalf_ofstring or null
parentobject or null
payment_settingsobject
post_payment_credit_notes_amountinteger

Smallest currency unit (minor units / cents). Credit notes issued against cash this invoice had already collected; it does not reduce amount_due. The pre-payment counterpart is not served.

receipt_numberstring or null<=5000 characters
renderingobject or null
shipping_costobject or null
starting_balanceinteger
statement_descriptorstring or null<=5000 characters
statusenum or null
Allowed values:
status_transitionsobject
subtotalinteger
subtotal_excluding_taxinteger or null
test_clockstring or null
totalinteger

Smallest currency unit (minor units / cents).

total_discount_amountslist of objects or null
total_excluding_taxinteger or null
total_pretax_credit_amountslist of objects or null
total_taxeslist of objects or null
webhooks_delivered_atinteger or null
hosted_invoice_urlstring or nullOptional<=5000 characters

The hosted invoice page, where the customer views and pays the invoice: null until the invoice is finalized. Fluveo mints a fresh link on every read, expiring with the emailed pay link (due date plus 7 days, at least 1 and at most 60 days; 30 days without a due date).

idstringOptional<=5000 characters
subscriptionstring or nullOptional