Void invoice
Void an invoice in a to_pay status. This action generates a corresponding credit note.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Indicates if an email for the generated credit note should be sent to the customer.
Response
Invoice ID.
Invoice number is generated by Hyperline and follows the format defined in your settings.
The type of the invoice:
- invoice: the base type for a legal invoice to charge your customer
- credit_note: the base type for a legal credit note to refund your customer or cancel an invoice
- document: a type that has no legal value you can generate from a subscription to create a summary for instance
invoice, credit_note, document, child_invoice_ref, child_creditnote_ref If the invoice is of type document you can give it a custom name (will be displayed before the number)
Indicates the current state of the invoice.
draft, open, to_pay, grace_period, partially_paid, paid, late, voided, closed, error, missing_info, archived, charged_on_parent, pending_parent_concat Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.
Reference to the purchase order linked to the invoice.
ID of the original invoice this credit note is linked to (only used for credit note).
Number of the original invoice this credit note is linked to (only used for credit note).
Currency code. See ISO 4217.
EUR, AED, AFN, XCD, ALL, AMD, AOA, ARS, USD, AUD, AWG, AZN, BAM, BBD, BDT, XOF, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, NOK, BWP, BYR, BZD, CAD, CDF, XAF, CHF, NZD, CLP, CNY, COP, CRC, CUP, CVE, ANG, CZK, DJF, DKK, DOP, DZD, EGP, MAD, ERN, ETB, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, XPF, NGN, NIO, NPR, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VEF, VND, VUV, WST, YER, ZAR, ZMW, ZWL Sum of the amount and taxes amount of all products on the invoice. Expressed in the currency's smallest unit.
Amount still need to be paid for the invoice. Expressed in the currency's smallest unit.
Amount already paid for the invoice. Expressed in the currency's smallest unit.
Amount corresponding to the recurring non-variable part of the total amount. Expressed in the currency's smallest unit.
Total amount without the taxes amount. Expressed in the currency's smallest unit.
Tax amount of the invoice. Expressed in the currency's smallest unit.
Tax amount of the invoice. Expressed in the currency's smallest unit.
standard: Default behavior, tax is automatically computed and applied.exempt: No tax rate applied because the customer country doesn't require it.reverse_charge: No tax rate applied because the customer is eligible to EU reverse charge.manual: Tax rate has been manually specified when creating the invoice.not_eligible: You've disabled tax collection in this country.
exempt, standard, reverse_charge, manual, not_eligible Amount corresponding to the discounted part of the total amount. Expressed in the currency's smallest unit.
Conversion rate used between the invoice currency and your accounting currency.
Amount converted using the conversion rate. Expressed in the currency's smallest unit.
Date of the conversion of the amount.
ID of the payment method used to pay the invoice.
Number of attempts to pay the invoice.
Custom note added to the invoice.
ID of the subscription related to the invoice.
Start date of the billing period of the invoice.
End date of the billing period of the invoice.
Emission date of the invoice.
Due date of the invoice. Computed from the emission date and the payment delay configured in your settings.
Date corresponding to the refund of the invoice, previously paid. A credit note exists with an original invoice ID equals to this invoice ID.
Date the invoice grace period ended. This happens at the emission date + the grace period duration configured in your settings.
Date the invoice was fully paid.
Date of the last update
Was this page helpful?