POST
/
v1
/
invoices
/
{id}
/
void

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
send_email
boolean
default: true

Indicates if an email for the generated credit note should be sent to the customer.

Response

200 - application/json
id
string
required

Invoice ID.

number
string
required

Invoice number is generated by Hyperline and follows the format defined in your settings.

type
enum<string>
required

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

Available options:
invoice,
credit_note,
document,
child_invoice_ref,
child_creditnote_ref
document_name
string | null
required

If the invoice is of type document you can give it a custom name (will be displayed before the number)

status
enum<string>
required

Indicates the current state of the invoice.

Available options:
draft,
open,
to_pay,
grace_period,
partially_paid,
paid,
late,
voided,
closed,
error,
missing_info,
archived,
charged_on_parent,
pending_parent_concat
reference
string | null
required

Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.

purchase_order
string | null
required

Reference to the purchase order linked to the invoice.

original_invoice_id
string | null
required

ID of the original invoice this credit note is linked to (only used for credit note).

original_invoice_number
string | null
required

Number of the original invoice this credit note is linked to (only used for credit note).

currency
enum<string>
required

Currency code. See ISO 4217.

Available options:
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
total_amount
number
required

Sum of the amount and taxes amount of all products on the invoice. Expressed in the currency's smallest unit.

amount_due
number
required

Amount still need to be paid for the invoice. Expressed in the currency's smallest unit.

amount_paid
number
required

Amount already paid for the invoice. Expressed in the currency's smallest unit.

amount_fixed
number
required

Amount corresponding to the recurring non-variable part of the total amount. Expressed in the currency's smallest unit.

amount_excluding_tax
number
required

Total amount without the taxes amount. Expressed in the currency's smallest unit.

tax_rate
number
required

Tax amount of the invoice. Expressed in the currency's smallest unit.

tax_amount
number
required

Tax amount of the invoice. Expressed in the currency's smallest unit.

tax_scheme
enum<string>
required
  • 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.
Available options:
exempt,
standard,
reverse_charge,
manual,
not_eligible
discount_amount
number
required

Amount corresponding to the discounted part of the total amount. Expressed in the currency's smallest unit.

conversion_rate
number | null
required

Conversion rate used between the invoice currency and your accounting currency.

converted_amount
number
required

Amount converted using the conversion rate. Expressed in the currency's smallest unit.

converted_at
string
required

Date of the conversion of the amount.

payment_method_id
string | null
required

ID of the payment method used to pay the invoice.

attempt_count
number
required

Number of attempts to pay the invoice.

custom_note
string | null
required

Custom note added to the invoice.

customer
object
required
seller
object
required
subscription_id
string | null
required

ID of the subscription related to the invoice.

period_starts_at
string
required

Start date of the billing period of the invoice.

period_ends_at
string
required

End date of the billing period of the invoice.

emitted_at
string
required

Emission date of the invoice.

due_at
string
required

Due date of the invoice. Computed from the emission date and the payment delay configured in your settings.

refunded_at
string
required

Date corresponding to the refund of the invoice, previously paid. A credit note exists with an original invoice ID equals to this invoice ID.

grace_period_ended_at
string
required

Date the invoice grace period ended. This happens at the emission date + the grace period duration configured in your settings.

settled_at
string
required

Date the invoice was fully paid.

updated_at
string
required

Date of the last update

line_items
object[]
required
transactions
object[]
required
coupons
object[]
required

Was this page helpful?

Validate draft invoiceGet invoice