Get invoicing entities

GET

invoicing-entities

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

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "inv123",
      "name": "Acme Corp",
      "trade_name": "Acme",
      "timezone": "America/New_York",
      "is_default": true,
      "currency": "USD",
      "accounting_currency": "USD",
      "address_line1": "123 Elm St",
      "address_line2": "Suite 5",
      "zip_code": "10001",
      "state": "NY",
      "city": "New York",
      "country": "USA",
      "tax_id": "123456789",
      "tax_id_valid": true,
      "billing_email": "billing@acmecorp.com",
      "invoice_number_pattern": "INV-#####",
      "credit_note_number_pattern": "CN-#####",
      "document_number_pattern": "DOC-#####",
      "next_invoice_number": 1001,
      "next_credit_note_number": 201,
      "next_document_number": 1501,
      "default_payment_delay": 30,
      "invoice_grace_period_duration": 7,
      "invoice_payment_initiation_delay": 2,
      "document_payment_initiation_delay": 2,
      "invoice_late_fees": "2% per month",
      "invoice_footer": "Thank you for your business.",
      "document_footer": "Thank you for your business.",
      "logo_url": "http://example.com/logo.png",
      "favicon_url": "http://example.com/logo.png",
      "brand_color": "#FF5733",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-04-01T00:00:00Z",
      "deleted_at": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Response

200 - application/json

meta

object

required

data

object[]

required

List of InvoicingEntity.

data.id

string

required

The unique identifier for the invoicing entity.

data.name

string

required

The name of the invoicing entity.

data.timezone

string | null

required

The timezone the invoicing entity operates in.

data.is_default

boolean

required

Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.

data.currency

enum<string>

required

The currency code that the invoicing entity operates in.

Available options:

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

data.accounting_currency

string

required

The currency used for accounting purposes.

data.address_line1

string | null

required

The first line of the address for the invoicing entity.

data.address_line2

string | null

required

The second line of the address for the invoicing entity.

data.zip_code

string | null

required

The postal code for the invoicing entity's address.

data.state

string | null

required

The state or province of the invoicing entity.

data.city

string | null

required

The city of the invoicing entity.

data.country

enum<string>

required

The country in which the invoicing entity is registered.

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

data.tax_id

string | null

required

The tax identification number of the invoicing entity.

data.billing_email

string | null

required

The billing email address for the invoicing entity.

data.invoice_number_pattern

string

required

The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.

data.credit_note_number_pattern

string

required

The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.

data.document_number_pattern

string

required

The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.

data.next_invoice_number

number

required

The next invoice number to be used.

data.next_credit_note_number

number

required

The next credit note number to be used.

data.next_document_number

number

required

The next document number to be used.

data.default_payment_delay

integer

required

The default payment term in days.

data.invoice_grace_period_duration

integer

required

The grace period duration in days.

data.invoice_payment_initiation_delay

integer | null

required

The payment initiation delay in days for the invoices.

data.document_payment_initiation_delay

integer | null

required

The payment initiation delay in days for the custom documents.

data.invoice_late_fees

string | null

required

The late fees applicable to the invoices.

data.invoice_footer

string | null

required

The footer text to be used in invoices.

data.document_footer

string | null

required

The footer text to be used in documents. If not specified, the invoice footer will be used.

data.logo_url

string | null

required

URL of the logo to be used in invoices.

data.favicon_url

string | null

required

URL of the logo to be used as favicon.

data.brand_color

string | null

required

Brand color to be used in invoices (hexadecimal color code).

Required string length: 4 - 9

data.created_at

string

required

The creation date of the invoicing entity.

data.updated_at

string

required

The last update date of the invoicing entity.

data.deleted_at

string | null

required

The date the invoicing entity was deleted, if applicable.

data.trade_name

string

The trade name of the invoicing entity.

data.tax_id_valid

boolean

Boolean indicating whether the tax ID is valid.

Was this page helpful?

Void invoice Get invoicing entity

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

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "inv123",
      "name": "Acme Corp",
      "trade_name": "Acme",
      "timezone": "America/New_York",
      "is_default": true,
      "currency": "USD",
      "accounting_currency": "USD",
      "address_line1": "123 Elm St",
      "address_line2": "Suite 5",
      "zip_code": "10001",
      "state": "NY",
      "city": "New York",
      "country": "USA",
      "tax_id": "123456789",
      "tax_id_valid": true,
      "billing_email": "billing@acmecorp.com",
      "invoice_number_pattern": "INV-#####",
      "credit_note_number_pattern": "CN-#####",
      "document_number_pattern": "DOC-#####",
      "next_invoice_number": 1001,
      "next_credit_note_number": 201,
      "next_document_number": 1501,
      "default_payment_delay": 30,
      "invoice_grace_period_duration": 7,
      "invoice_payment_initiation_delay": 2,
      "document_payment_initiation_delay": 2,
      "invoice_late_fees": "2% per month",
      "invoice_footer": "Thank you for your business.",
      "document_footer": "Thank you for your business.",
      "logo_url": "http://example.com/logo.png",
      "favicon_url": "http://example.com/logo.png",
      "brand_color": "#FF5733",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-04-01T00:00:00Z",
      "deleted_at": "<string>"
    }
  ]
}

API documentation

Integrations

Analytics

Billable events

Companies

Coupons

Custom properties

Customers

Customers > Credits

Customers > Payment methods

Integrations

Invoices

Invoicing entities

OAuth2

Organisations

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Taxes

Third-party apps

Wallets

Webhooks

Get invoicing entities

Authorizations

Response