PUT
/
v1
/
invoicing-entities
/
{id}
curl --request PUT \
  --url https://api.hyperline.co/v1/invoicing-entities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "currency": "USD",
  "name": "Acme Corp",
  "country": "USA",
  "timezone": "America/New_York",
  "is_default": true,
  "address_line1": "123 Elm St",
  "address_line2": "Suite 5",
  "zip_code": "10001",
  "state": "NY",
  "city": "New York",
  "tax_id": "123456789",
  "billing_email": "billing@acmecorp.com",
  "accounting_currency": "USD",
  "invoice_footer": "Thank you for your business.",
  "invoice_late_fees": "2% per month",
  "logo_url": "http://example.com/logo.png",
  "brand_color": "#FF5733"
}'
{
  "id": "inv123",
  "currency": "USD",
  "name": "Acme Corp",
  "country": "USA",
  "timezone": "America/New_York",
  "is_default": true,
  "address_line1": "123 Elm St",
  "address_line2": "Suite 5",
  "zip_code": "10001",
  "state": "NY",
  "city": "New York",
  "tax_id": "123456789",
  "tax_id_is_valid": true,
  "billing_email": "billing@acmecorp.com",
  "accounting_currency": "USD",
  "invoice_number_pattern": "INV-#####",
  "next_invoice_number": 1001,
  "next_credit_note_number": 201,
  "next_document_number": 1501,
  "invoice_footer": "Thank you for your business.",
  "invoice_late_fees": "2% per month",
  "logo_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
headerrequired

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

Path Parameters

id
string
required

Body

application/json
currency
string

The currency code that the invoicing entity operates in.

name
string

The name of the invoicing entity.

country
string

The country in which the invoicing entity is registered.

timezone
string
default: Europe/Paris

The timezone the invoicing entity operates in.

is_default
boolean
default: false

Flag to indicate if this is the default invoicing entity.

address_line1
string | null

The first line of the address for the invoicing entity.

address_line2
string | null

The second line of the address for the invoicing entity.

zip_code
string | null

The postal code for the invoicing entity's address.

state
string | null

The state or province of the invoicing entity.

city
string | null

The city of the invoicing entity.

tax_id
string | null

The tax identification number of the invoicing entity.

billing_email
string | null

The billing email address for the invoicing entity.

accounting_currency
string

The currency used for accounting purposes.

invoice_footer
string | null

The footer text to be used in invoices.

invoice_late_fees
string | null

The late fees applicable to the invoices.

logo_url
string | null

URL of the logo to be used in invoices.

brand_color
string | null

Brand color to be used in invoices, must start with '#'.

Response

200 - application/json
id
string
required

The unique identifier for the invoicing entity.

currency
string
required

The currency code that the invoicing entity operates in.

name
string
required

The name of the invoicing entity.

country
string
required

The country in which the invoicing entity is registered.

timezone
string | null
default: Europe/Paris

The timezone the invoicing entity operates in.

is_default
boolean
default: falserequired

Flag to indicate if this is the default invoicing entity.

address_line1
string | null
required

The first line of the address for the invoicing entity.

address_line2
string | null
required

The second line of the address for the invoicing entity.

zip_code
string | null
required

The postal code for the invoicing entity's address.

state
string | null
required

The state or province of the invoicing entity.

city
string | null
required

The city of the invoicing entity.

tax_id
string | null
required

The tax identification number of the invoicing entity.

tax_id_is_valid
boolean

Boolean indicating whether the tax ID is valid.

billing_email
string | null
required

The billing email address for the invoicing entity.

accounting_currency
string
required

The currency used for accounting purposes.

invoice_number_pattern
string
required

The pattern used for generating invoice numbers.

next_invoice_number
number
required

The next invoice number to be used.

next_credit_note_number
number
required

The next credit note number to be used.

next_document_number
number
required

The next document number to be used.

invoice_footer
string | null
required

The footer text to be used in invoices.

invoice_late_fees
string | null
required

The late fees applicable to the invoices.

logo_url
string | null
required

URL of the logo to be used in invoices.

brand_color
string | null
required

Brand color to be used in invoices, must start with '#'.

created_at
string
required

The creation date of the invoicing entity record.

updated_at
string
required

The last update date of the invoicing entity record.

deleted_at
string | null
required

The date the invoicing entity record was deleted, if applicable.

Get invoicing entityDelete invoicing entity