Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Create invoices payload
Customer ID.
"inv_1eTaiytfA0i2Va"
1
- Option 1
- Option 2
A unique identifier for the invoices in the batch
"invoice-123"
Currency code of the invoice. 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
"EUR"
Current invoice status.
draft
: Invoice is in draft mode (not finalized yet).open
: Invoice for the current billing period, which will be issued at the end of the period (used for invoices with usage-based data).grace_period
: Invoice is in a review period after being issued for the billing period and before becoming due for payment.to_pay
: Invoice is awaiting payment.partially_paid
: Invoice is partially paid.paid
: Invoice is fully paid.voided
: Invoice has been voided and is no longer valid.closed
: Invoice was not issued and has been discarded.error
: Invoice failed to be paid.archived
: A previous version of an invoice.charged_on_parent
: Invoice is charged on the parent customer.pending_parent_concat
: Invoice is pending invoices concatenation on the parent customer to be grouped.uncollectible
: Invoice is uncollectible (bad debt).
to_pay
, paid
, draft
"paid"
ID of the invoicing entity attached to the invoice.
"ive_47484fjdhy5"
Invoice number. If specified, the invoice will be considered as imported from an external source and the number will not be generated by Hyperline. You are responsible for avoiding duplicates and ensuring it does not impact the numbering sequence in Hyperline.
"INV-35"
Type of the invoice.
invoice
: Legal invoice to be paid by your customer.credit_note
: Legal credit note cancelling an invoice and refunding your customer.document
: Custom document with no legal value. Can be generated from a subscription to meet specific needs.
invoice
, credit_note
, document
"invoice"
If the invoice is of type document
you can give it a custom name (displayed on the final PDF).
Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.
"V0KAHOU6J3"
Reference to the purchase order linked to the invoice.
"PO-12345"
Custom note added to the invoice.
"Thank you for your purchase!"
Additional information added to the invoice. If not defined, it will be inherited from the invoicing entity's settings.
"This invoice must be paid within the payment delay indicated. After this period a late payment penalty of 10% will be applied."
Footer added to the invoice. If not defined, it will be inherited from the invoicing entity's settings.
"ACME (Acme SAS) is a company registered in France | SIREN N°123456"
Tax rate of the invoice.
0 <= x <= 100
20
Tax scheme of the invoice.
auto
: Tax is automatically computed and applied.not_eligible
: Tax collection is disabled for the invoice.
auto
, not_eligible
"auto"
Payment method strategy used to charge the invoice. Only applies to to_pay
status.
current
: Use the current default payment method of the customer.external
: Manage the payment of the invoice outside of Hyperline.
current
, external
"external"
ID of the default payment method used to pay the invoice. Transactions related to the invoice may use different payment methods.
"pm_1ryTrMj4TTAT1N"
ID of the bank account displayed on the invoice. Transactions related to the invoice may use different bank accounts.
"bac_KJyPrMA1toAqRG"
Emission date of the invoice.
"2024-10-13T00:00:00.000Z"
Due date of the invoice. Computed from the emission date and the payment delay configured in your settings.
"2024-11-12T00:00:00.000Z"
Date the invoice was fully paid.
"2024-10-15T14:01:56.000Z"
Key/value pairs to store any metadata useful in your context.
- Option 1
- Option 2
- Option 3
- Option 4