Update invoicing entity

curl --request PUT \
  --url https://api.hyperline.co/v1/invoicing-entities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Corp",
  "registration_number": "00011122334",
  "tax_id": "123456789",
  "billing_email": "billing@acmecorp.com",
  "timezone": "America/New_York",
  "language": "en",
  "is_default": true,
  "address_line1": "123 Elm St",
  "address_line2": "Suite 5",
  "zip_code": "10001",
  "state": "NY",
  "city": "New York",
  "country": "USA",
  "currency": "USD",
  "accounting_currency": "USD",
  "invoice_number_pattern": "INV-#####",
  "credit_note_number_pattern": "CN-#####",
  "document_number_pattern": "DOC-#####",
  "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",
  "forced_customer_type": null,
  "credit_note_wallet_refund_enabled": false,
  "standalone_credit_note_creation_enabled": true,
  "fx_conversion_display_enabled": true
}
'

import requests

url = "https://api.hyperline.co/v1/invoicing-entities/{id}"

payload = {
    "name": "Acme Corp",
    "registration_number": "00011122334",
    "tax_id": "123456789",
    "billing_email": "billing@acmecorp.com",
    "timezone": "America/New_York",
    "language": "en",
    "is_default": True,
    "address_line1": "123 Elm St",
    "address_line2": "Suite 5",
    "zip_code": "10001",
    "state": "NY",
    "city": "New York",
    "country": "USA",
    "currency": "USD",
    "accounting_currency": "USD",
    "invoice_number_pattern": "INV-#####",
    "credit_note_number_pattern": "CN-#####",
    "document_number_pattern": "DOC-#####",
    "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",
    "forced_customer_type": None,
    "credit_note_wallet_refund_enabled": False,
    "standalone_credit_note_creation_enabled": True,
    "fx_conversion_display_enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Acme Corp',
    registration_number: '00011122334',
    tax_id: '123456789',
    billing_email: 'billing@acmecorp.com',
    timezone: 'America/New_York',
    language: 'en',
    is_default: true,
    address_line1: '123 Elm St',
    address_line2: 'Suite 5',
    zip_code: '10001',
    state: 'NY',
    city: 'New York',
    country: 'USA',
    currency: 'USD',
    accounting_currency: 'USD',
    invoice_number_pattern: 'INV-#####',
    credit_note_number_pattern: 'CN-#####',
    document_number_pattern: 'DOC-#####',
    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',
    forced_customer_type: null,
    credit_note_wallet_refund_enabled: false,
    standalone_credit_note_creation_enabled: true,
    fx_conversion_display_enabled: true
  })
};

fetch('https://api.hyperline.co/v1/invoicing-entities/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperline.co/v1/invoicing-entities/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Acme Corp',
    'registration_number' => '00011122334',
    'tax_id' => '123456789',
    'billing_email' => 'billing@acmecorp.com',
    'timezone' => 'America/New_York',
    'language' => 'en',
    'is_default' => true,
    'address_line1' => '123 Elm St',
    'address_line2' => 'Suite 5',
    'zip_code' => '10001',
    'state' => 'NY',
    'city' => 'New York',
    'country' => 'USA',
    'currency' => 'USD',
    'accounting_currency' => 'USD',
    'invoice_number_pattern' => 'INV-#####',
    'credit_note_number_pattern' => 'CN-#####',
    'document_number_pattern' => 'DOC-#####',
    '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',
    'forced_customer_type' => null,
    'credit_note_wallet_refund_enabled' => false,
    'standalone_credit_note_creation_enabled' => true,
    'fx_conversion_display_enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/invoicing-entities/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Acme Corp\",\n  \"registration_number\": \"00011122334\",\n  \"tax_id\": \"123456789\",\n  \"billing_email\": \"billing@acmecorp.com\",\n  \"timezone\": \"America/New_York\",\n  \"language\": \"en\",\n  \"is_default\": true,\n  \"address_line1\": \"123 Elm St\",\n  \"address_line2\": \"Suite 5\",\n  \"zip_code\": \"10001\",\n  \"state\": \"NY\",\n  \"city\": \"New York\",\n  \"country\": \"USA\",\n  \"currency\": \"USD\",\n  \"accounting_currency\": \"USD\",\n  \"invoice_number_pattern\": \"INV-#####\",\n  \"credit_note_number_pattern\": \"CN-#####\",\n  \"document_number_pattern\": \"DOC-#####\",\n  \"default_payment_delay\": 30,\n  \"invoice_grace_period_duration\": 7,\n  \"invoice_payment_initiation_delay\": 2,\n  \"document_payment_initiation_delay\": 2,\n  \"invoice_late_fees\": \"2% per month\",\n  \"invoice_footer\": \"Thank you for your business.\",\n  \"document_footer\": \"Thank you for your business.\",\n  \"logo_url\": \"http://example.com/logo.png\",\n  \"favicon_url\": \"http://example.com/logo.png\",\n  \"brand_color\": \"#FF5733\",\n  \"forced_customer_type\": null,\n  \"credit_note_wallet_refund_enabled\": false,\n  \"standalone_credit_note_creation_enabled\": true,\n  \"fx_conversion_display_enabled\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.hyperline.co/v1/invoicing-entities/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Corp\",\n  \"registration_number\": \"00011122334\",\n  \"tax_id\": \"123456789\",\n  \"billing_email\": \"billing@acmecorp.com\",\n  \"timezone\": \"America/New_York\",\n  \"language\": \"en\",\n  \"is_default\": true,\n  \"address_line1\": \"123 Elm St\",\n  \"address_line2\": \"Suite 5\",\n  \"zip_code\": \"10001\",\n  \"state\": \"NY\",\n  \"city\": \"New York\",\n  \"country\": \"USA\",\n  \"currency\": \"USD\",\n  \"accounting_currency\": \"USD\",\n  \"invoice_number_pattern\": \"INV-#####\",\n  \"credit_note_number_pattern\": \"CN-#####\",\n  \"document_number_pattern\": \"DOC-#####\",\n  \"default_payment_delay\": 30,\n  \"invoice_grace_period_duration\": 7,\n  \"invoice_payment_initiation_delay\": 2,\n  \"document_payment_initiation_delay\": 2,\n  \"invoice_late_fees\": \"2% per month\",\n  \"invoice_footer\": \"Thank you for your business.\",\n  \"document_footer\": \"Thank you for your business.\",\n  \"logo_url\": \"http://example.com/logo.png\",\n  \"favicon_url\": \"http://example.com/logo.png\",\n  \"brand_color\": \"#FF5733\",\n  \"forced_customer_type\": null,\n  \"credit_note_wallet_refund_enabled\": false,\n  \"standalone_credit_note_creation_enabled\": true,\n  \"fx_conversion_display_enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/invoicing-entities/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Acme Corp\",\n  \"registration_number\": \"00011122334\",\n  \"tax_id\": \"123456789\",\n  \"billing_email\": \"billing@acmecorp.com\",\n  \"timezone\": \"America/New_York\",\n  \"language\": \"en\",\n  \"is_default\": true,\n  \"address_line1\": \"123 Elm St\",\n  \"address_line2\": \"Suite 5\",\n  \"zip_code\": \"10001\",\n  \"state\": \"NY\",\n  \"city\": \"New York\",\n  \"country\": \"USA\",\n  \"currency\": \"USD\",\n  \"accounting_currency\": \"USD\",\n  \"invoice_number_pattern\": \"INV-#####\",\n  \"credit_note_number_pattern\": \"CN-#####\",\n  \"document_number_pattern\": \"DOC-#####\",\n  \"default_payment_delay\": 30,\n  \"invoice_grace_period_duration\": 7,\n  \"invoice_payment_initiation_delay\": 2,\n  \"document_payment_initiation_delay\": 2,\n  \"invoice_late_fees\": \"2% per month\",\n  \"invoice_footer\": \"Thank you for your business.\",\n  \"document_footer\": \"Thank you for your business.\",\n  \"logo_url\": \"http://example.com/logo.png\",\n  \"favicon_url\": \"http://example.com/logo.png\",\n  \"brand_color\": \"#FF5733\",\n  \"forced_customer_type\": null,\n  \"credit_note_wallet_refund_enabled\": false,\n  \"standalone_credit_note_creation_enabled\": true,\n  \"fx_conversion_display_enabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "inv123",
  "name": "Acme Corp",
  "timezone": "America/New_York",
  "language": "en",
  "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",
  "registration_number": "00011122334",
  "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",
  "forced_customer_type": null,
  "credit_note_wallet_refund_enabled": false,
  "standalone_credit_note_creation_enabled": true,
  "fx_conversion_display_enabled": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-04-01T00:00:00Z",
  "deleted_at": null,
  "trade_name": "Acme"
}

PUT

invoicing-entities

{id}

Update invoicing entity

curl --request PUT \
  --url https://api.hyperline.co/v1/invoicing-entities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Corp",
  "registration_number": "00011122334",
  "tax_id": "123456789",
  "billing_email": "billing@acmecorp.com",
  "timezone": "America/New_York",
  "language": "en",
  "is_default": true,
  "address_line1": "123 Elm St",
  "address_line2": "Suite 5",
  "zip_code": "10001",
  "state": "NY",
  "city": "New York",
  "country": "USA",
  "currency": "USD",
  "accounting_currency": "USD",
  "invoice_number_pattern": "INV-#####",
  "credit_note_number_pattern": "CN-#####",
  "document_number_pattern": "DOC-#####",
  "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",
  "forced_customer_type": null,
  "credit_note_wallet_refund_enabled": false,
  "standalone_credit_note_creation_enabled": true,
  "fx_conversion_display_enabled": true
}
'

import requests

url = "https://api.hyperline.co/v1/invoicing-entities/{id}"

payload = {
    "name": "Acme Corp",
    "registration_number": "00011122334",
    "tax_id": "123456789",
    "billing_email": "billing@acmecorp.com",
    "timezone": "America/New_York",
    "language": "en",
    "is_default": True,
    "address_line1": "123 Elm St",
    "address_line2": "Suite 5",
    "zip_code": "10001",
    "state": "NY",
    "city": "New York",
    "country": "USA",
    "currency": "USD",
    "accounting_currency": "USD",
    "invoice_number_pattern": "INV-#####",
    "credit_note_number_pattern": "CN-#####",
    "document_number_pattern": "DOC-#####",
    "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",
    "forced_customer_type": None,
    "credit_note_wallet_refund_enabled": False,
    "standalone_credit_note_creation_enabled": True,
    "fx_conversion_display_enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Acme Corp',
    registration_number: '00011122334',
    tax_id: '123456789',
    billing_email: 'billing@acmecorp.com',
    timezone: 'America/New_York',
    language: 'en',
    is_default: true,
    address_line1: '123 Elm St',
    address_line2: 'Suite 5',
    zip_code: '10001',
    state: 'NY',
    city: 'New York',
    country: 'USA',
    currency: 'USD',
    accounting_currency: 'USD',
    invoice_number_pattern: 'INV-#####',
    credit_note_number_pattern: 'CN-#####',
    document_number_pattern: 'DOC-#####',
    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',
    forced_customer_type: null,
    credit_note_wallet_refund_enabled: false,
    standalone_credit_note_creation_enabled: true,
    fx_conversion_display_enabled: true
  })
};

fetch('https://api.hyperline.co/v1/invoicing-entities/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperline.co/v1/invoicing-entities/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Acme Corp',
    'registration_number' => '00011122334',
    'tax_id' => '123456789',
    'billing_email' => 'billing@acmecorp.com',
    'timezone' => 'America/New_York',
    'language' => 'en',
    'is_default' => true,
    'address_line1' => '123 Elm St',
    'address_line2' => 'Suite 5',
    'zip_code' => '10001',
    'state' => 'NY',
    'city' => 'New York',
    'country' => 'USA',
    'currency' => 'USD',
    'accounting_currency' => 'USD',
    'invoice_number_pattern' => 'INV-#####',
    'credit_note_number_pattern' => 'CN-#####',
    'document_number_pattern' => 'DOC-#####',
    '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',
    'forced_customer_type' => null,
    'credit_note_wallet_refund_enabled' => false,
    'standalone_credit_note_creation_enabled' => true,
    'fx_conversion_display_enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/invoicing-entities/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Acme Corp\",\n  \"registration_number\": \"00011122334\",\n  \"tax_id\": \"123456789\",\n  \"billing_email\": \"billing@acmecorp.com\",\n  \"timezone\": \"America/New_York\",\n  \"language\": \"en\",\n  \"is_default\": true,\n  \"address_line1\": \"123 Elm St\",\n  \"address_line2\": \"Suite 5\",\n  \"zip_code\": \"10001\",\n  \"state\": \"NY\",\n  \"city\": \"New York\",\n  \"country\": \"USA\",\n  \"currency\": \"USD\",\n  \"accounting_currency\": \"USD\",\n  \"invoice_number_pattern\": \"INV-#####\",\n  \"credit_note_number_pattern\": \"CN-#####\",\n  \"document_number_pattern\": \"DOC-#####\",\n  \"default_payment_delay\": 30,\n  \"invoice_grace_period_duration\": 7,\n  \"invoice_payment_initiation_delay\": 2,\n  \"document_payment_initiation_delay\": 2,\n  \"invoice_late_fees\": \"2% per month\",\n  \"invoice_footer\": \"Thank you for your business.\",\n  \"document_footer\": \"Thank you for your business.\",\n  \"logo_url\": \"http://example.com/logo.png\",\n  \"favicon_url\": \"http://example.com/logo.png\",\n  \"brand_color\": \"#FF5733\",\n  \"forced_customer_type\": null,\n  \"credit_note_wallet_refund_enabled\": false,\n  \"standalone_credit_note_creation_enabled\": true,\n  \"fx_conversion_display_enabled\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.hyperline.co/v1/invoicing-entities/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Corp\",\n  \"registration_number\": \"00011122334\",\n  \"tax_id\": \"123456789\",\n  \"billing_email\": \"billing@acmecorp.com\",\n  \"timezone\": \"America/New_York\",\n  \"language\": \"en\",\n  \"is_default\": true,\n  \"address_line1\": \"123 Elm St\",\n  \"address_line2\": \"Suite 5\",\n  \"zip_code\": \"10001\",\n  \"state\": \"NY\",\n  \"city\": \"New York\",\n  \"country\": \"USA\",\n  \"currency\": \"USD\",\n  \"accounting_currency\": \"USD\",\n  \"invoice_number_pattern\": \"INV-#####\",\n  \"credit_note_number_pattern\": \"CN-#####\",\n  \"document_number_pattern\": \"DOC-#####\",\n  \"default_payment_delay\": 30,\n  \"invoice_grace_period_duration\": 7,\n  \"invoice_payment_initiation_delay\": 2,\n  \"document_payment_initiation_delay\": 2,\n  \"invoice_late_fees\": \"2% per month\",\n  \"invoice_footer\": \"Thank you for your business.\",\n  \"document_footer\": \"Thank you for your business.\",\n  \"logo_url\": \"http://example.com/logo.png\",\n  \"favicon_url\": \"http://example.com/logo.png\",\n  \"brand_color\": \"#FF5733\",\n  \"forced_customer_type\": null,\n  \"credit_note_wallet_refund_enabled\": false,\n  \"standalone_credit_note_creation_enabled\": true,\n  \"fx_conversion_display_enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/invoicing-entities/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Acme Corp\",\n  \"registration_number\": \"00011122334\",\n  \"tax_id\": \"123456789\",\n  \"billing_email\": \"billing@acmecorp.com\",\n  \"timezone\": \"America/New_York\",\n  \"language\": \"en\",\n  \"is_default\": true,\n  \"address_line1\": \"123 Elm St\",\n  \"address_line2\": \"Suite 5\",\n  \"zip_code\": \"10001\",\n  \"state\": \"NY\",\n  \"city\": \"New York\",\n  \"country\": \"USA\",\n  \"currency\": \"USD\",\n  \"accounting_currency\": \"USD\",\n  \"invoice_number_pattern\": \"INV-#####\",\n  \"credit_note_number_pattern\": \"CN-#####\",\n  \"document_number_pattern\": \"DOC-#####\",\n  \"default_payment_delay\": 30,\n  \"invoice_grace_period_duration\": 7,\n  \"invoice_payment_initiation_delay\": 2,\n  \"document_payment_initiation_delay\": 2,\n  \"invoice_late_fees\": \"2% per month\",\n  \"invoice_footer\": \"Thank you for your business.\",\n  \"document_footer\": \"Thank you for your business.\",\n  \"logo_url\": \"http://example.com/logo.png\",\n  \"favicon_url\": \"http://example.com/logo.png\",\n  \"brand_color\": \"#FF5733\",\n  \"forced_customer_type\": null,\n  \"credit_note_wallet_refund_enabled\": false,\n  \"standalone_credit_note_creation_enabled\": true,\n  \"fx_conversion_display_enabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "inv123",
  "name": "Acme Corp",
  "timezone": "America/New_York",
  "language": "en",
  "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",
  "registration_number": "00011122334",
  "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",
  "forced_customer_type": null,
  "credit_note_wallet_refund_enabled": false,
  "standalone_credit_note_creation_enabled": true,
  "fx_conversion_display_enabled": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-04-01T00:00:00Z",
  "deleted_at": null,
  "trade_name": "Acme"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Body

application/json

name

string

The name of the invoicing entity.

Example:

"Acme Corp"

registration_number

string | null

The registration number of the invoicing entity.

Example:

"00011122334"

tax_id

string | null

The tax identification number of the invoicing entity.

Example:

"123456789"

billing_email

string<email> | null

The billing email address for the invoicing entity.

Example:

"billing@acmecorp.com"

timezone

string

The timezone the invoicing entity operates in.

Example:

"America/New_York"

language

enum<string>

The default language of the invoicing entity.

Available options:

fr,

en,

de,

it,

lt,

nl,

es,

pt,

pl

Example:

"en"

is_default

boolean

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

Example:

true

address_line1

string | null

The first line of the address for the invoicing entity.

Example:

"123 Elm St"

address_line2

string | null

The second line of the address for the invoicing entity.

Example:

"Suite 5"

zip_code

string | null

The postal code for the invoicing entity's address.

Example:

"10001"

state

string | null

The state or province of the invoicing entity.

Example:

"NY"

city

string | null

The city of the invoicing entity.

Example:

"New York"

country

enum<string>

The country in which the invoicing entity is registered. It cannot be changed after creation.

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BF,

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,

ES-CE,

ES-ML,

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,

IC,

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,

PT-20,

PT-30,

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

Example:

"USA"

currency

enum<string>

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,

BGN,

BHD,

BIF,

XOF,

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

Example:

"USD"

accounting_currency

enum<string>

The currency used for accounting purposes.

Available options:

EUR,

AED,

AFN,

XCD,

ALL,

AMD,

AOA,

ARS,

USD,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

XOF,

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

Example:

"USD"

invoice_number_pattern

string

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

Example:

"INV-#####"

credit_note_number_pattern

string

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

Example:

"CN-#####"

document_number_pattern

string

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

Example:

"DOC-#####"

default_payment_delay

integer

The default payment term in days.

Required range: x >= 0

Example:

30

invoice_grace_period_duration

integer

The grace period duration in days.

Required range: x >= 0

Example:

7

invoice_payment_initiation_delay

integer | null

The payment initiation delay in days for the invoices.

Required range: x >= 0

Example:

2

document_payment_initiation_delay

integer | null

The payment initiation delay in days for the custom documents.

Required range: x >= 0

Example:

2

invoice_late_fees

string | null

The late fees applicable to the invoices.

Example:

"2% per month"

invoice_footer

string | null

The footer text to be used in invoices.

Example:

"Thank you for your business."

document_footer

string | null

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

Example:

"Thank you for your business."

logo_url

string<uri> | null

URL of the logo to be used in invoices.

Example:

"http://example.com/logo.png"

favicon_url

string<uri> | null

URL of the logo to be used as favicon.

Example:

"http://example.com/logo.png"

brand_color

string | null

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

Required string length: 4 - 9

Pattern: ^#

Example:

"#FF5733"

forced_customer_type

enum<string> | null

Forces all customers created under this invoicing entity to have this type. Set to null to allow users to choose.

Available options:

corporate,

person

Example:

null

credit_note_wallet_refund_enabled

boolean

When enabled and no refund_method is specified, credit note refunds default to the customer's wallet, including credit notes generated by subscription updates, cancellations, and transitions. An explicit refund_method always wins. Requires wallets to be enabled at the workspace level.

Example:

false

standalone_credit_note_creation_enabled

boolean

Whether credit notes without an original invoice can be created under this invoicing entity. Defaults to true.

Example:

true

fx_conversion_display_enabled

boolean

Whether the exchange rate and converted amount in the accounting currency are displayed on the invoice PDF when the invoice currency differs from the accounting currency. The conversion data is still stored and returned by the API when disabled. Defaults to true.

Example:

true

Response

200 - application/json

string

required

The unique identifier for the invoicing entity.

Example:

"inv123"

name

string

required

The name of the invoicing entity.

Example:

"Acme Corp"

timezone

string

required

The timezone the invoicing entity operates in.

Example:

"America/New_York"

language

enum<string>

required

The default language of the invoicing entity.

Available options:

fr,

en,

de,

it,

lt,

nl,

es,

pt,

pl

Example:

"en"

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.

Example:

true

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,

BGN,

BHD,

BIF,

XOF,

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

Example:

"USD"

accounting_currency

string

required

The currency used for accounting purposes.

Example:

"USD"

address_line1

string | null

required

The first line of the address for the invoicing entity.

Example:

"123 Elm St"

address_line2

string | null

required

The second line of the address for the invoicing entity.

Example:

"Suite 5"

zip_code

string | null

required

The postal code for the invoicing entity's address.

Example:

"10001"

state

string | null

required

The state or province of the invoicing entity.

Example:

"NY"

city

string | null

required

The city of the invoicing entity.

Example:

"New York"

country

enum<string>

required

The country in which the invoicing entity is registered. It cannot be changed after creation.

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BF,

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,

ES-CE,

ES-ML,

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,

IC,

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,

PT-20,

PT-30,

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

Example:

"USA"

registration_number

string | null

required

The registration number of the invoicing entity.

Example:

"00011122334"

tax_id

string | null

required

The tax identification number of the invoicing entity.

Example:

"123456789"

tax_id_valid

boolean | null

required

Boolean indicating whether the tax ID is valid.

Example:

true

billing_email

string<email> | null

required

The billing email address for the invoicing entity.

Example:

"billing@acmecorp.com"

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}.

Example:

"INV-#####"

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}.

Example:

"CN-#####"

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}.

Example:

"DOC-#####"

next_invoice_number

number

required

The next invoice number to be used.

Example:

1001

next_credit_note_number

number

required

The next credit note number to be used.

Example:

201

next_document_number

number

required

The next document number to be used.

Example:

1501

default_payment_delay

integer

required

The default payment term in days.

Example:

30

invoice_grace_period_duration

integer

required

The grace period duration in days.

Example:

7

invoice_payment_initiation_delay

integer | null

required

The payment initiation delay in days for the invoices.

Example:

2

document_payment_initiation_delay

integer | null

required

The payment initiation delay in days for the custom documents.

Example:

2

invoice_late_fees

string | null

required

The late fees applicable to the invoices.

Example:

"2% per month"

invoice_footer

string | null

required

The footer text to be used in invoices.

Example:

"Thank you for your business."

document_footer

string | null

required

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

Example:

"Thank you for your business."

logo_url

string<uri> | null

required

URL of the logo to be used in invoices.

Example:

"http://example.com/logo.png"

favicon_url

string<uri> | null

required

URL of the logo to be used as favicon.

Example:

"http://example.com/logo.png"

brand_color

string | null

required

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

Required string length: 4 - 9

Pattern: ^#

Example:

"#FF5733"

forced_customer_type

enum<string> | null

required

Forces all customers created under this invoicing entity to have this type. Set to null to allow users to choose.

Available options:

corporate,

person

Example:

null

credit_note_wallet_refund_enabled

boolean

required

Example:

false

standalone_credit_note_creation_enabled

boolean

required

Whether credit notes without an original invoice can be created under this invoicing entity. Defaults to true.

Example:

true

fx_conversion_display_enabled

boolean

required

Example:

true

created_at

string<date>

required

Creation date of the invoicing entity.

Example:

"2024-01-01T00:00:00Z"

updated_at

string<date>

required

Last edition date of the invoicing entity.

Example:

"2024-04-01T00:00:00Z"

deleted_at

string<date> | null

required

Date of the invoicing entity deletion.

Example:

null

trade_name

string

The trade name of the invoicing entity.

Example:

"Acme"

⌘I