GET
/
v1
/
invoices
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,
      "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"
    }
  ]
}

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
id
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,
error,
paid,
partially_paid,
outstanding,
refunded,
late,
draft
status__in
Available options:
all,
open,
grace_period,
to_pay,
error,
paid,
partially_paid,
outstanding,
refunded,
late,
draft
status__notIn
Available options:
all,
open,
grace_period,
to_pay,
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
search
string
category
Available options:
refund,
subscription,
otp
category__in
Available options:
refund,
subscription,
otp
category__notIn
Available options:
refund,
subscription,
otp

Response

200 - application/json
meta
object
required
data
object[]
required

List of Invoice.