GET
/
v1
/
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": "<string>",
      "status": "paid",
      "reference": "V0KAHOU6J3",
      "purchase_order": "PO-12345",
      "original_invoice_id": "<string>",
      "original_invoice_number": "<string>",
      "currency": "EUR",
      "total_amount": 24000,
      "amount_due": 0,
      "amount_paid": 24000,
      "amount_fixed": 20000,
      "amount_excluding_tax": 20000,
      "tax_rate": 20,
      "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": "<string>",
        "vat_number": "FR123456789",
        "address": {
          "name": "Acme",
          "line1": "5 rue de Paradis",
          "line2": "<string>",
          "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": "<string>",
          "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": "2023-11-07T05:31:56Z",
      "grace_period_ended_at": "2023-11-07T05:31:56Z",
      "settled_at": "2024-10-15T14:01:56.000Z",
      "updated_at": "2024-10-15T14:01:56.000Z",
      "properties": {},
      "line_items": [
        {
          "id": "ili_0FACNpeoEFkGu3",
          "name": "Platform access",
          "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": "<string>",
          "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"
        }
      ],
      "coupons": [
        {
          "id": "cou_DKL4Xcb5VSa8CQ",
          "name": "Partner discount",
          "discount_amount": 2000,
          "discount_percent": 123,
          "line_item_ids": [
            "ili_0FACNpeoEFkGu3"
          ]
        }
      ],
      "transactions": [
        {
          "id": "tra_2QdJDDUej969ev",
          "type": "subscription",
          "amount": 31500,
          "currency": "EUR",
          "customer_id": "cus_QalW2vTAdkR6IY",
          "provider_id": "pi_xxxxxxxxxx",
          "process_at": "2024-11-12T07:38:39.222Z",
          "refunded_at": "2023-11-07T05:31:56Z",
          "last_refreshed_at": "2023-11-07T05:31:56Z",
          "provider_fee": {
            "amount": 123,
            "currency": "EUR",
            "exchange_rate": 123
          },
          "chargeback": {
            "amount": 31500,
            "last_chargeback_at": "2024-10-13T10:00:01.860Z"
          },
          "payment_method_type": "card",
          "payment_method": {
            "id": "pm_1xMpj5bwRqN7LM",
            "status": "active",
            "type": "card",
            "last_4_digits": 2718,
            "expiration_date": "2026-11",
            "brand": "visa"
          },
          "status": "settled"
        }
      ]
    }
  ]
}

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
​
type
Available options:
invoice,
refund,
document
​
type__in
Available options:
invoice,
refund,
document
​
status
Available options:
all,
open,
grace_period,
to_pay,
to_reconcile,
error,
paid,
partially_paid,
outstanding,
refunded,
document,
late,
draft,
voided,
closed
​
status__in
Available options:
all,
open,
grace_period,
to_pay,
to_reconcile,
error,
paid,
partially_paid,
outstanding,
refunded,
document,
late,
draft,
voided,
closed
​
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
​
emission_date
string
​
emission_date__not
string
​
emission_date__isNull
string
​
emission_date__isNotNull
string
​
emission_date__equals
string
​
emission_date__lt
string
​
emission_date__lte
string
​
emission_date__gt
string
​
emission_date__gte
string
​
due_date
string
​
due_date__not
string
​
due_date__isNull
string
​
due_date__isNotNull
string
​
due_date__equals
string
​
due_date__lt
string
​
due_date__lte
string
​
due_date__gt
string
​
due_date__gte
string
​
updated_at
string
​
updated_at__not
string
​
updated_at__isNull
string
​
updated_at__isNotNull
string
​
updated_at__equals
string
​
updated_at__lt
string
​
updated_at__lte
string
​
updated_at__gt
string
​
updated_at__gte
string

Response

200 - application/json

The response is of type object.