List invoices

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

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "inv_1eTaiytfA0i2Va",
      "number": "INV-35",
      "type": "invoice",
      "document_name": null,
      "status": "paid",
      "reference": "V0KAHOU6J3",
      "purchase_order": "PO-12345",
      "currency": "EUR",
      "source": "hyperline",
      "total_amount": 24000,
      "amount_due": 0,
      "amount_paid": 24000,
      "amount_fixed": 20000,
      "amount_excluding_tax": 20000,
      "tax_rate": 123,
      "tax_amount": 4000,
      "tax_scheme": "standard",
      "discount_amount": 0,
      "conversion_rate": 1,
      "converted_amount": 24000,
      "converted_at": "2024-10-13T02:00:00.000Z",
      "payment_method_id": "pm_1ryTrMj4TTAT1N",
      "bank_account_id": "bac_KJyPrMA1toAqRG",
      "custom_note": "Thank you for your purchase!",
      "additional_info": "This invoice must be paid within the payment delay indicated. After this period a late payment penalty of 10% will be applied.",
      "footer": "ACME (Acme SAS) is a company registered in France | SIREN N°123456",
      "customer": {
        "id": "cus_Typ0px2W0aiEtl",
        "name": "Acme",
        "email": "billing@acme.com",
        "external_id": null,
        "vat_number": "<string>",
        "tax_id": "FR123456789",
        "address": {
          "name": "Acme",
          "line1": "5 rue de Paradis",
          "line2": null,
          "city": "Paris",
          "zip": "75010",
          "state": "CA",
          "country": "FR"
        }
      },
      "seller": {
        "id": "ive_47484fjdhy5",
        "name": "Name of the invoicing entity",
        "tax_id": "FR5878986578",
        "address": {
          "name": "Acme",
          "line1": "5 rue de Paradis",
          "line2": null,
          "city": "Paris",
          "zip": "75010",
          "state": "CA",
          "country": "FR"
        }
      },
      "subscription_id": "sub_amiaWZ3lzDIWaoT",
      "period_starts_at": "2024-10-13T00:00:00.000Z",
      "period_ends_at": "2024-11-13T00:00:00.000Z",
      "emitted_at": "2024-10-13T00:00:00.000Z",
      "due_at": "2024-11-12T00:00:00.000Z",
      "refunded_at": null,
      "grace_period_ended_at": null,
      "settled_at": "2024-10-15T14:01:56.000Z",
      "updated_at": "2024-10-15T14:01:56.000Z",
      "properties": null,
      "custom_properties": null,
      "original_invoice_id": null,
      "original_invoice_number": null,
      "line_items": [
        {
          "id": "ili_0FACNpeoEFkGu3",
          "name": "Platform access",
          "entry_type": "debit",
          "product_id": "itm_KbLcWt2qm5p1S2",
          "product_type": "flat_fee",
          "units_count": 1,
          "unit_amount": 24000,
          "amount": 24000,
          "amount_excluding_tax": 20000,
          "tax_rate": 20,
          "tax_rate_id": null,
          "tax_amount": 4000,
          "discount_amount": 0,
          "discount_percent": 123,
          "period_starts_at": "2024-10-13T00:00:00.000Z",
          "period_ends_at": "2024-11-13T00:00:00.000Z",
          "revenue_type": "recurring",
          "revenue_interval_count": 1,
          "revenue_interval_period": "months",
          "display_unit_amount": true,
          "display_service_period": true,
          "original_line_item_id": null
        }
      ],
      "coupons": [
        {
          "id": "cou_DKL4Xcb5VSa8CQ",
          "name": "Partner discount",
          "discount_amount": 2000,
          "discount_percent": null,
          "line_item_ids": [
            "ili_0FACNpeoEFkGu3"
          ]
        }
      ],
      "transactions": [
        {
          "id": "tra_2QdJDDUej969ev",
          "type": "subscription",
          "amount": 31500,
          "currency": "EUR",
          "customer_id": "cus_QalW2vTAdkR6IY",
          "provider_id": "<string>",
          "process_at": "2024-11-12T07:38:39.222Z",
          "refunded_at": null,
          "last_refreshed_at": null,
          "provider_fee": null,
          "chargeback": null,
          "integrations": [
            {
              "entity_id": "123456789",
              "provider_name": "stripe",
              "provider_account_id": "acc_1234567890"
            }
          ],
          "payment_method": {
            "id": "pm_1xMpj5bwRqN7LM",
            "status": "active",
            "type": "card",
            "last_4_digits": 2718,
            "expiration_date": "2027-11",
            "brand": "<string>"
          },
          "status": "settled"
        }
      ],
      "public_url": "<string>"
    }
  ]
}

GET

invoices

List invoices

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

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "inv_1eTaiytfA0i2Va",
      "number": "INV-35",
      "type": "invoice",
      "document_name": null,
      "status": "paid",
      "reference": "V0KAHOU6J3",
      "purchase_order": "PO-12345",
      "currency": "EUR",
      "source": "hyperline",
      "total_amount": 24000,
      "amount_due": 0,
      "amount_paid": 24000,
      "amount_fixed": 20000,
      "amount_excluding_tax": 20000,
      "tax_rate": 123,
      "tax_amount": 4000,
      "tax_scheme": "standard",
      "discount_amount": 0,
      "conversion_rate": 1,
      "converted_amount": 24000,
      "converted_at": "2024-10-13T02:00:00.000Z",
      "payment_method_id": "pm_1ryTrMj4TTAT1N",
      "bank_account_id": "bac_KJyPrMA1toAqRG",
      "custom_note": "Thank you for your purchase!",
      "additional_info": "This invoice must be paid within the payment delay indicated. After this period a late payment penalty of 10% will be applied.",
      "footer": "ACME (Acme SAS) is a company registered in France | SIREN N°123456",
      "customer": {
        "id": "cus_Typ0px2W0aiEtl",
        "name": "Acme",
        "email": "billing@acme.com",
        "external_id": null,
        "vat_number": "<string>",
        "tax_id": "FR123456789",
        "address": {
          "name": "Acme",
          "line1": "5 rue de Paradis",
          "line2": null,
          "city": "Paris",
          "zip": "75010",
          "state": "CA",
          "country": "FR"
        }
      },
      "seller": {
        "id": "ive_47484fjdhy5",
        "name": "Name of the invoicing entity",
        "tax_id": "FR5878986578",
        "address": {
          "name": "Acme",
          "line1": "5 rue de Paradis",
          "line2": null,
          "city": "Paris",
          "zip": "75010",
          "state": "CA",
          "country": "FR"
        }
      },
      "subscription_id": "sub_amiaWZ3lzDIWaoT",
      "period_starts_at": "2024-10-13T00:00:00.000Z",
      "period_ends_at": "2024-11-13T00:00:00.000Z",
      "emitted_at": "2024-10-13T00:00:00.000Z",
      "due_at": "2024-11-12T00:00:00.000Z",
      "refunded_at": null,
      "grace_period_ended_at": null,
      "settled_at": "2024-10-15T14:01:56.000Z",
      "updated_at": "2024-10-15T14:01:56.000Z",
      "properties": null,
      "custom_properties": null,
      "original_invoice_id": null,
      "original_invoice_number": null,
      "line_items": [
        {
          "id": "ili_0FACNpeoEFkGu3",
          "name": "Platform access",
          "entry_type": "debit",
          "product_id": "itm_KbLcWt2qm5p1S2",
          "product_type": "flat_fee",
          "units_count": 1,
          "unit_amount": 24000,
          "amount": 24000,
          "amount_excluding_tax": 20000,
          "tax_rate": 20,
          "tax_rate_id": null,
          "tax_amount": 4000,
          "discount_amount": 0,
          "discount_percent": 123,
          "period_starts_at": "2024-10-13T00:00:00.000Z",
          "period_ends_at": "2024-11-13T00:00:00.000Z",
          "revenue_type": "recurring",
          "revenue_interval_count": 1,
          "revenue_interval_period": "months",
          "display_unit_amount": true,
          "display_service_period": true,
          "original_line_item_id": null
        }
      ],
      "coupons": [
        {
          "id": "cou_DKL4Xcb5VSa8CQ",
          "name": "Partner discount",
          "discount_amount": 2000,
          "discount_percent": null,
          "line_item_ids": [
            "ili_0FACNpeoEFkGu3"
          ]
        }
      ],
      "transactions": [
        {
          "id": "tra_2QdJDDUej969ev",
          "type": "subscription",
          "amount": 31500,
          "currency": "EUR",
          "customer_id": "cus_QalW2vTAdkR6IY",
          "provider_id": "<string>",
          "process_at": "2024-11-12T07:38:39.222Z",
          "refunded_at": null,
          "last_refreshed_at": null,
          "provider_fee": null,
          "chargeback": null,
          "integrations": [
            {
              "entity_id": "123456789",
              "provider_name": "stripe",
              "provider_account_id": "acc_1234567890"
            }
          ],
          "payment_method": {
            "id": "pm_1xMpj5bwRqN7LM",
            "status": "active",
            "type": "card",
            "last_4_digits": 2718,
            "expiration_date": "2027-11",
            "brand": "<string>"
          },
          "status": "settled"
        }
      ],
      "public_url": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

take

number | null

default:50

Required range: 0 <= x <= 100

skip

number | null

default:0

Required range: x >= 0

order

enum<string>

default:desc

Sort direction.

Available options:

asc,

desc

Example:

"desc"

sort

enum<string>

Field used to sort the results.

Available options:

created_at,

emitted_at

type

Available options:

invoice,

refund,

document,

child_invoice_ref,

child_creditnote_ref

type__in

Available options:

invoice,

refund,

document,

child_invoice_ref,

child_creditnote_ref

status

Available options:

all,

open,

grace_period,

to_pay,

to_reconcile,

error,

paid,

partially_paid,

outstanding,

refunded,

late,

draft,

voided,

closed,

uncollectible

status__in

Available options:

all,

open,

grace_period,

to_pay,

to_reconcile,

error,

paid,

partially_paid,

outstanding,

refunded,

late,

draft,

voided,

closed,

uncollectible

customer_id

string

customer_id__not

string

customer_id__isNull

string

customer_id__isNotNull

string

customer_id__equals

string

customer_id__contains

string

customer_id__startsWith

string

customer_id__endWith

string

customer_external_id

string

subscription_id

string

subscription_id__not

string

subscription_id__isNull

string

subscription_id__isNotNull

string

subscription_id__equals

string

subscription_id__contains

string

subscription_id__startsWith

string

subscription_id__endWith

string

invoicing_entity_id

string

invoicing_entity_id__not

string

invoicing_entity_id__isNull

string

invoicing_entity_id__isNotNull

string

invoicing_entity_id__equals

string

invoicing_entity_id__contains

string

invoicing_entity_id__startsWith

string

invoicing_entity_id__endWith

string

invoice_number

string

invoice_number__not

string

invoice_number__isNull

string

invoice_number__isNotNull

string

invoice_number__equals

string

invoice_number__contains

string

invoice_number__startsWith

string

invoice_number__endWith

string

original_invoice_id

string

original_invoice_id__not

string

original_invoice_id__isNull

string

original_invoice_id__isNotNull

string

original_invoice_id__equals

string

original_invoice_id__contains

string

original_invoice_id__startsWith

string

original_invoice_id__endWith

string

original_invoice_number

string

original_invoice_number__not

string

original_invoice_number__isNull

string

original_invoice_number__isNotNull

string

original_invoice_number__equals

string

original_invoice_number__contains

string

original_invoice_number__startsWith

string

original_invoice_number__endWith

string

line_item_id

string

period_start

string<date-time>

period_start__not

string<date-time>

period_start__isNull

string<date-time>

period_start__isNotNull

string<date-time>

period_start__equals

string<date-time>

period_start__lt

string<date-time>

period_start__lte

string<date-time>

period_start__gt

string<date-time>

period_start__gte

string<date-time>

period_end

string<date-time>

period_end__not

string<date-time>

period_end__isNull

string<date-time>

period_end__isNotNull

string<date-time>

period_end__equals

string<date-time>

period_end__lt

string<date-time>

period_end__lte

string<date-time>

period_end__gt

string<date-time>

period_end__gte

string<date-time>

emission_date

string<date-time>

emission_date__not

string<date-time>

emission_date__isNull

string<date-time>

emission_date__isNotNull

string<date-time>

emission_date__equals

string<date-time>

emission_date__lt

string<date-time>

emission_date__lte

string<date-time>

emission_date__gt

string<date-time>

emission_date__gte

string<date-time>

due_date

string<date-time>

due_date__not

string<date-time>

due_date__isNull

string<date-time>

due_date__isNotNull

string<date-time>

due_date__equals

string<date-time>

due_date__lt

string<date-time>

due_date__lte

string<date-time>

due_date__gt

string<date-time>

due_date__gte

string<date-time>

updated_at

string<date-time>

updated_at__not

string<date-time>

updated_at__isNull

string<date-time>

updated_at__isNotNull

string<date-time>

updated_at__equals

string<date-time>

updated_at__lt

string<date-time>

updated_at__lte

string<date-time>

updated_at__gt

string<date-time>

updated_at__gte

string<date-time>

Response

200 - application/json

Documentation Index

Authorizations

Query Parameters

Response