Get invoices

GET

invoices

take

number

skip

number

string

id__not

string

id__isNull

string

id__isNotNull

string

id__equals

string

id__contains

string

id__startsWith

string

id__endWith

string

customerId

string

customerId__not

string

customerId__isNull

string

customerId__isNotNull

string

customerId__equals

string

customerId__contains

string

customerId__startsWith

string

customerId__endWith

string

customerName

string

customerName__not

string

customerName__isNull

string

customerName__isNotNull

string

customerName__equals

string

customerName__contains

string

customerName__startsWith

string

customerName__endWith

string

invoiceNumber

string

invoiceNumber__not

string

invoiceNumber__isNull

string

invoiceNumber__isNotNull

string

invoiceNumber__equals

string

invoiceNumber__contains

string

invoiceNumber__startsWith

string

invoiceNumber__endWith

string

dueDate

string

dueDate__not

string

dueDate__isNull

string

dueDate__isNotNull

string

dueDate__equals

string

dueDate__lt

string

dueDate__lte

string

dueDate__gt

string

dueDate__gte

string

emissionDate

string

emissionDate__not

string

emissionDate__isNull

string

emissionDate__isNotNull

string

emissionDate__equals

string

emissionDate__lt

string

emissionDate__lte

string

emissionDate__gt

string

emissionDate__gte

string

periodStart

string

periodStart__not

string

periodStart__isNull

string

periodStart__isNotNull

string

periodStart__equals

string

periodStart__lt

string

periodStart__lte

string

periodStart__gt

string

periodStart__gte

string

periodEnd

string

periodEnd__not

string

periodEnd__isNull

string

periodEnd__isNotNull

string

periodEnd__equals

string

periodEnd__lt

string

periodEnd__lte

string

periodEnd__gt

string

periodEnd__gte

string

settledAt

string

settledAt__not

string

settledAt__isNull

string

settledAt__isNotNull

string

settledAt__equals

string

settledAt__lt

string

settledAt__lte

string

settledAt__gt

string

settledAt__gte

string

subscriptionId

string

subscriptionId__not

string

subscriptionId__isNull

string

subscriptionId__isNotNull

string

subscriptionId__equals

string

subscriptionId__contains

string

subscriptionId__startsWith

string

subscriptionId__endWith

string

status

enum<string>

status__in

enum<string>

status__notIn

enum<string>

type

enum<string>

type__in

enum<string>

type__notIn

enum<string>

paymentMethod

enum<string>

paymentMethod__in

enum<string>

paymentMethod__notIn

enum<string>

string

Authorizations

Authorization

string

headerrequired

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

Query Parameters

take

number | null

default: 50

skip

number | null

default: 0

string

id__not

string

id__isNull

string

id__isNotNull

string

id__equals

string

id__contains

string

id__startsWith

string

id__endWith

string

customerId

string

customerId__not

string

customerId__isNull

string

customerId__isNotNull

string

customerId__equals

string

customerId__contains

string

customerId__startsWith

string

customerId__endWith

string

customerName

string

customerName__not

string

customerName__isNull

string

customerName__isNotNull

string

customerName__equals

string

customerName__contains

string

customerName__startsWith

string

customerName__endWith

string

invoiceNumber

string

invoiceNumber__not

string

invoiceNumber__isNull

string

invoiceNumber__isNotNull

string

invoiceNumber__equals

string

invoiceNumber__contains

string

invoiceNumber__startsWith

string

invoiceNumber__endWith

string

dueDate

string

dueDate__not

string

dueDate__isNull

string

dueDate__isNotNull

string

dueDate__equals

string

dueDate__lt

string

dueDate__lte

string

dueDate__gt

string

dueDate__gte

string

emissionDate

string

emissionDate__not

string

emissionDate__isNull

string

emissionDate__isNotNull

string

emissionDate__equals

string

emissionDate__lt

string

emissionDate__lte

string

emissionDate__gt

string

emissionDate__gte

string

periodStart

string

periodStart__not

string

periodStart__isNull

string

periodStart__isNotNull

string

periodStart__equals

string

periodStart__lt

string

periodStart__lte

string

periodStart__gt

string

periodStart__gte

string

periodEnd

string

periodEnd__not

string

periodEnd__isNull

string

periodEnd__isNotNull

string

periodEnd__equals

string

periodEnd__lt

string

periodEnd__lte

string

periodEnd__gt

string

periodEnd__gte

string

settledAt

string

settledAt__not

string

settledAt__isNull

string

settledAt__isNotNull

string

settledAt__equals

string

settledAt__lt

string

settledAt__lte

string

settledAt__gt

string

settledAt__gte

string

subscriptionId

string

subscriptionId__not

string

subscriptionId__isNull

string

subscriptionId__isNotNull

string

subscriptionId__equals

string

subscriptionId__contains

string

subscriptionId__startsWith

string

subscriptionId__endWith

string

status

Available options:

all,

open,

grace_period,

to_pay,

to_reconcile,

error,

paid,

partially_paid,

outstanding,

refunded,

late,

draft

status__in

Available options:

all,

open,

grace_period,

to_pay,

to_reconcile,

error,

paid,

partially_paid,

outstanding,

refunded,

late,

draft

status__notIn

Available options:

all,

open,

grace_period,

to_pay,

to_reconcile,

error,

paid,

partially_paid,

outstanding,

refunded,

late,

draft

type

Available options:

invoice,

refund

type__in

Available options:

invoice,

refund

type__notIn

Available options:

invoice,

refund

paymentMethod

Available options:

card,

transfer,

external,

missing,

direct_debit,

direct_debit_sepa,

direct_debit_ach,

direct_debit_bacs

paymentMethod__in

Available options:

card,

transfer,

external,

missing,

direct_debit,

direct_debit_sepa,

direct_debit_ach,

direct_debit_bacs

paymentMethod__notIn

Available options:

card,

transfer,

external,

missing,

direct_debit,

direct_debit_sepa,

direct_debit_ach,

direct_debit_bacs

string

Response

200 - application/json

meta

object

required

data

object[]

required

List of Invoice.

data.id

string

required

Invoice ID.

data.number

string

required

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

data.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

data.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)

data.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

data.reference

string | null

required

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

data.purchase_order

string | null

required

Reference to the purchase order linked to the invoice.

data.original_invoice_id

string | null

required

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

data.original_invoice_number

string | null

required

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

data.currency

string

required

Currency code. See ISO 4217.

data.total_amount

number

required

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

data.amount_due

number

required

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

data.amount_paid

number

required

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

data.amount_fixed

number

required

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

data.amount_excluding_tax

number

required

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

data.tax_rate

number

required

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

data.tax_amount

number

required

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

data.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

data.discount_amount

number

required

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

data.conversion_rate

number | null

required

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

data.converted_amount

number

required

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

data.converted_at

string | null

required

Date of the conversion of the amount.

data.payment_method_id

string | null

required

ID of the payment method used to pay the invoice.

data.attempt_count

number

required

Number of attempts to pay the invoice.

data.custom_note

string | null

required

Custom note added to the invoice.

data.customer

object

required

data.seller

object

required

data.subscription_id

string | null

required

ID of the subscription related to the invoice.

data.period_starts_at

string | null

required

Beginning of the billing period of the invoice.

data.period_ends_at

string | null

required

End of the billing period of the invoice.

data.emitted_at

string

required

Emission date of the invoice.

data.due_at

string

required

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

data.refunded_at

string | null

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.

data.grace_period_ended_at

string | null

required

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

data.settled_at

string | null

required

Date the invoice was fully paid.

Create component token Create one-off invoice

curl --request GET \
  --url https://api.hyperline.co/v1/invoices \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 123
  },
  "data": [
    {
      "id": "inv_1eTaiytfA0i2Va",
      "number": "INV-35",
      "type": "invoice",
      "document_name": "<string>",
      "status": "paid",
      "reference": "V0KAHOU6J3",
      "purchase_order": "PO-12345",
      "original_invoice_id": "<string>",
      "original_invoice_number": "<string>",
      "currency": "EUR",
      "total_amount": 24000,
      "amount_due": 123,
      "amount_paid": 24000,
      "amount_fixed": 20000,
      "amount_excluding_tax": 20000,
      "tax_rate": 20,
      "tax_amount": 4000,
      "tax_scheme": "standard",
      "discount_amount": 123,
      "conversion_rate": 1,
      "converted_amount": 24000,
      "converted_at": "2023-10-13T02:00:00.000Z",
      "payment_method_id": "pm_1ryTrMj4TTAT1N",
      "attempt_count": 123,
      "custom_note": "Thank you for your business!",
      "customer": {
        "id": "cus_Typ0px2W0aiEtl",
        "name": "Acme",
        "email": "billing@acme.com",
        "external_id": "<string>",
        "vat_number": "FR123456789",
        "address": {
          "name": "Acme",
          "line1": "5 rue de Paradis",
          "line2": "<string>",
          "city": "Paris",
          "zip": "75010",
          "state": "<string>",
          "country": "FR"
        }
      },
      "seller": {
        "id": "ive_47484fjdhy5",
        "name": "Name of the invoicing entity",
        "tax_id": "FR5878986578",
        "address": {
          "name": "Acme",
          "line1": "5 rue de Paradis",
          "line2": "<string>",
          "city": "Paris",
          "zip": "75010",
          "state": "<string>",
          "country": "FR"
        }
      },
      "subscription_id": "sub_amiaWZ3lzDIWaoT",
      "period_starts_at": "2023-10-13T00:00:00.000Z",
      "period_ends_at": "2023-11-13T00:00:00.000Z",
      "emitted_at": "2023-10-13T00:00:00.000Z",
      "due_at": "2023-11-12T00:00:00.000Z",
      "refunded_at": "2023-11-07T05:31:56Z",
      "grace_period_ended_at": "2023-11-07T05:31:56Z",
      "settled_at": "2023-10-15T14:01:56.000Z"
    }
  ]
}

API documentation

Integrations

Analytics

Billable events

Companies

Coupons

Custom properties

Customers

Customers > Credits

Integrations

Invoices

Invoicing entities

OAuth2

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Third-party apps

Wallets

Webhooks

Authorizations

Query Parameters

Response