A command to modify an existing company, including identification, contact, banking, and tax information.

curl --request PATCH \
  --url https://api.jtl-cloud.com/erp/v2/companies/{companyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "companyName": "<string>",
  "owner": "<string>",
  "street": "<string>",
  "postalCode": "<string>",
  "city": "<string>",
  "country": "<string>",
  "countryIsoCode": "<string>",
  "phone": "<string>",
  "fax": "<string>",
  "emailAddress": "<string>",
  "website": "<string>",
  "bankCode": "<string>",
  "accountNumber": "<string>",
  "bankName": "<string>",
  "taxId": "<string>",
  "iBAN": "<string>",
  "bIC": "<string>",
  "accountHolder": "<string>",
  "creditorId": "<string>",
  "payPalEmailAddress": "<string>",
  "isSmallBusinessOwner": true,
  "dHLIntrashipCustomerId": "<string>",
  "uPSCustomerId": "<string>",
  "companyVatIdentifiers": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "countryIsoCode": "<string>",
      "vatIdentifier": "<string>",
      "isShippingCountry": true
    }
  ]
}
'

import requests

url = "https://api.jtl-cloud.com/erp/v2/companies/{companyId}"

payload = {
    "companyName": "<string>",
    "owner": "<string>",
    "street": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "country": "<string>",
    "countryIsoCode": "<string>",
    "phone": "<string>",
    "fax": "<string>",
    "emailAddress": "<string>",
    "website": "<string>",
    "bankCode": "<string>",
    "accountNumber": "<string>",
    "bankName": "<string>",
    "taxId": "<string>",
    "iBAN": "<string>",
    "bIC": "<string>",
    "accountHolder": "<string>",
    "creditorId": "<string>",
    "payPalEmailAddress": "<string>",
    "isSmallBusinessOwner": True,
    "dHLIntrashipCustomerId": "<string>",
    "uPSCustomerId": "<string>",
    "companyVatIdentifiers": [
        {
            "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
            "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
            "countryIsoCode": "<string>",
            "vatIdentifier": "<string>",
            "isShippingCountry": True
        }
    ]
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    companyName: '<string>',
    owner: '<string>',
    street: '<string>',
    postalCode: '<string>',
    city: '<string>',
    country: '<string>',
    countryIsoCode: '<string>',
    phone: '<string>',
    fax: '<string>',
    emailAddress: '<string>',
    website: '<string>',
    bankCode: '<string>',
    accountNumber: '<string>',
    bankName: '<string>',
    taxId: '<string>',
    iBAN: '<string>',
    bIC: '<string>',
    accountHolder: '<string>',
    creditorId: '<string>',
    payPalEmailAddress: '<string>',
    isSmallBusinessOwner: true,
    dHLIntrashipCustomerId: '<string>',
    uPSCustomerId: '<string>',
    companyVatIdentifiers: [
      {
        id: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
        companyId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
        countryIsoCode: '<string>',
        vatIdentifier: '<string>',
        isShippingCountry: true
      }
    ]
  })
};

fetch('https://api.jtl-cloud.com/erp/v2/companies/{companyId}', 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.jtl-cloud.com/erp/v2/companies/{companyId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'companyName' => '<string>',
    'owner' => '<string>',
    'street' => '<string>',
    'postalCode' => '<string>',
    'city' => '<string>',
    'country' => '<string>',
    'countryIsoCode' => '<string>',
    'phone' => '<string>',
    'fax' => '<string>',
    'emailAddress' => '<string>',
    'website' => '<string>',
    'bankCode' => '<string>',
    'accountNumber' => '<string>',
    'bankName' => '<string>',
    'taxId' => '<string>',
    'iBAN' => '<string>',
    'bIC' => '<string>',
    'accountHolder' => '<string>',
    'creditorId' => '<string>',
    'payPalEmailAddress' => '<string>',
    'isSmallBusinessOwner' => true,
    'dHLIntrashipCustomerId' => '<string>',
    'uPSCustomerId' => '<string>',
    'companyVatIdentifiers' => [
        [
                'id' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
                'companyId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
                'countryIsoCode' => '<string>',
                'vatIdentifier' => '<string>',
                'isShippingCountry' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$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.jtl-cloud.com/erp/v2/companies/{companyId}"

	payload := strings.NewReader("{\n  \"companyName\": \"<string>\",\n  \"owner\": \"<string>\",\n  \"street\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"city\": \"<string>\",\n  \"country\": \"<string>\",\n  \"countryIsoCode\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"fax\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"website\": \"<string>\",\n  \"bankCode\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"bankName\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"iBAN\": \"<string>\",\n  \"bIC\": \"<string>\",\n  \"accountHolder\": \"<string>\",\n  \"creditorId\": \"<string>\",\n  \"payPalEmailAddress\": \"<string>\",\n  \"isSmallBusinessOwner\": true,\n  \"dHLIntrashipCustomerId\": \"<string>\",\n  \"uPSCustomerId\": \"<string>\",\n  \"companyVatIdentifiers\": [\n    {\n      \"id\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n      \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n      \"countryIsoCode\": \"<string>\",\n      \"vatIdentifier\": \"<string>\",\n      \"isShippingCountry\": true\n    }\n  ]\n}")

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

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	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.patch("https://api.jtl-cloud.com/erp/v2/companies/{companyId}")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"companyName\": \"<string>\",\n  \"owner\": \"<string>\",\n  \"street\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"city\": \"<string>\",\n  \"country\": \"<string>\",\n  \"countryIsoCode\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"fax\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"website\": \"<string>\",\n  \"bankCode\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"bankName\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"iBAN\": \"<string>\",\n  \"bIC\": \"<string>\",\n  \"accountHolder\": \"<string>\",\n  \"creditorId\": \"<string>\",\n  \"payPalEmailAddress\": \"<string>\",\n  \"isSmallBusinessOwner\": true,\n  \"dHLIntrashipCustomerId\": \"<string>\",\n  \"uPSCustomerId\": \"<string>\",\n  \"companyVatIdentifiers\": [\n    {\n      \"id\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n      \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n      \"countryIsoCode\": \"<string>\",\n      \"vatIdentifier\": \"<string>\",\n      \"isShippingCountry\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/companies/{companyId}")

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

request = Net::HTTP::Patch.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"companyName\": \"<string>\",\n  \"owner\": \"<string>\",\n  \"street\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"city\": \"<string>\",\n  \"country\": \"<string>\",\n  \"countryIsoCode\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"fax\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"website\": \"<string>\",\n  \"bankCode\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"bankName\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"iBAN\": \"<string>\",\n  \"bIC\": \"<string>\",\n  \"accountHolder\": \"<string>\",\n  \"creditorId\": \"<string>\",\n  \"payPalEmailAddress\": \"<string>\",\n  \"isSmallBusinessOwner\": true,\n  \"dHLIntrashipCustomerId\": \"<string>\",\n  \"uPSCustomerId\": \"<string>\",\n  \"companyVatIdentifiers\": [\n    {\n      \"id\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n      \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n      \"countryIsoCode\": \"<string>\",\n      \"vatIdentifier\": \"<string>\",\n      \"isShippingCountry\": true\n    }\n  ]\n}"

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

{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "companyName": "<string>",
  "owner": "<string>",
  "street": "<string>",
  "postalCode": "<string>",
  "city": "<string>",
  "country": "<string>",
  "countryIsoCode": "<string>",
  "phone": "<string>",
  "fax": "<string>",
  "emailAddress": "<string>",
  "website": "<string>",
  "bankCode": "<string>",
  "accountNumber": "<string>",
  "bankName": "<string>",
  "taxId": "<string>",
  "iBAN": "<string>",
  "bIC": "<string>",
  "accountHolder": "<string>",
  "creditorId": "<string>",
  "payPalEmailAddress": "<string>",
  "isSmallBusinessOwner": true,
  "dHLIntrashipCustomerId": "<string>",
  "uPSCustomerId": "<string>",
  "companyVatIdentifiers": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "countryIsoCode": "<string>",
      "vatIdentifier": "<string>",
      "isShippingCountry": true
    }
  ]
}

PATCH

companies

{companyId}

A command to modify an existing company, including identification, contact, banking, and tax information.

curl --request PATCH \
  --url https://api.jtl-cloud.com/erp/v2/companies/{companyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "companyName": "<string>",
  "owner": "<string>",
  "street": "<string>",
  "postalCode": "<string>",
  "city": "<string>",
  "country": "<string>",
  "countryIsoCode": "<string>",
  "phone": "<string>",
  "fax": "<string>",
  "emailAddress": "<string>",
  "website": "<string>",
  "bankCode": "<string>",
  "accountNumber": "<string>",
  "bankName": "<string>",
  "taxId": "<string>",
  "iBAN": "<string>",
  "bIC": "<string>",
  "accountHolder": "<string>",
  "creditorId": "<string>",
  "payPalEmailAddress": "<string>",
  "isSmallBusinessOwner": true,
  "dHLIntrashipCustomerId": "<string>",
  "uPSCustomerId": "<string>",
  "companyVatIdentifiers": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "countryIsoCode": "<string>",
      "vatIdentifier": "<string>",
      "isShippingCountry": true
    }
  ]
}
'

import requests

url = "https://api.jtl-cloud.com/erp/v2/companies/{companyId}"

payload = {
    "companyName": "<string>",
    "owner": "<string>",
    "street": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "country": "<string>",
    "countryIsoCode": "<string>",
    "phone": "<string>",
    "fax": "<string>",
    "emailAddress": "<string>",
    "website": "<string>",
    "bankCode": "<string>",
    "accountNumber": "<string>",
    "bankName": "<string>",
    "taxId": "<string>",
    "iBAN": "<string>",
    "bIC": "<string>",
    "accountHolder": "<string>",
    "creditorId": "<string>",
    "payPalEmailAddress": "<string>",
    "isSmallBusinessOwner": True,
    "dHLIntrashipCustomerId": "<string>",
    "uPSCustomerId": "<string>",
    "companyVatIdentifiers": [
        {
            "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
            "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
            "countryIsoCode": "<string>",
            "vatIdentifier": "<string>",
            "isShippingCountry": True
        }
    ]
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    companyName: '<string>',
    owner: '<string>',
    street: '<string>',
    postalCode: '<string>',
    city: '<string>',
    country: '<string>',
    countryIsoCode: '<string>',
    phone: '<string>',
    fax: '<string>',
    emailAddress: '<string>',
    website: '<string>',
    bankCode: '<string>',
    accountNumber: '<string>',
    bankName: '<string>',
    taxId: '<string>',
    iBAN: '<string>',
    bIC: '<string>',
    accountHolder: '<string>',
    creditorId: '<string>',
    payPalEmailAddress: '<string>',
    isSmallBusinessOwner: true,
    dHLIntrashipCustomerId: '<string>',
    uPSCustomerId: '<string>',
    companyVatIdentifiers: [
      {
        id: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
        companyId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
        countryIsoCode: '<string>',
        vatIdentifier: '<string>',
        isShippingCountry: true
      }
    ]
  })
};

fetch('https://api.jtl-cloud.com/erp/v2/companies/{companyId}', 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.jtl-cloud.com/erp/v2/companies/{companyId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'companyName' => '<string>',
    'owner' => '<string>',
    'street' => '<string>',
    'postalCode' => '<string>',
    'city' => '<string>',
    'country' => '<string>',
    'countryIsoCode' => '<string>',
    'phone' => '<string>',
    'fax' => '<string>',
    'emailAddress' => '<string>',
    'website' => '<string>',
    'bankCode' => '<string>',
    'accountNumber' => '<string>',
    'bankName' => '<string>',
    'taxId' => '<string>',
    'iBAN' => '<string>',
    'bIC' => '<string>',
    'accountHolder' => '<string>',
    'creditorId' => '<string>',
    'payPalEmailAddress' => '<string>',
    'isSmallBusinessOwner' => true,
    'dHLIntrashipCustomerId' => '<string>',
    'uPSCustomerId' => '<string>',
    'companyVatIdentifiers' => [
        [
                'id' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
                'companyId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
                'countryIsoCode' => '<string>',
                'vatIdentifier' => '<string>',
                'isShippingCountry' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$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.jtl-cloud.com/erp/v2/companies/{companyId}"

	payload := strings.NewReader("{\n  \"companyName\": \"<string>\",\n  \"owner\": \"<string>\",\n  \"street\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"city\": \"<string>\",\n  \"country\": \"<string>\",\n  \"countryIsoCode\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"fax\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"website\": \"<string>\",\n  \"bankCode\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"bankName\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"iBAN\": \"<string>\",\n  \"bIC\": \"<string>\",\n  \"accountHolder\": \"<string>\",\n  \"creditorId\": \"<string>\",\n  \"payPalEmailAddress\": \"<string>\",\n  \"isSmallBusinessOwner\": true,\n  \"dHLIntrashipCustomerId\": \"<string>\",\n  \"uPSCustomerId\": \"<string>\",\n  \"companyVatIdentifiers\": [\n    {\n      \"id\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n      \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n      \"countryIsoCode\": \"<string>\",\n      \"vatIdentifier\": \"<string>\",\n      \"isShippingCountry\": true\n    }\n  ]\n}")

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

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	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.patch("https://api.jtl-cloud.com/erp/v2/companies/{companyId}")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"companyName\": \"<string>\",\n  \"owner\": \"<string>\",\n  \"street\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"city\": \"<string>\",\n  \"country\": \"<string>\",\n  \"countryIsoCode\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"fax\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"website\": \"<string>\",\n  \"bankCode\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"bankName\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"iBAN\": \"<string>\",\n  \"bIC\": \"<string>\",\n  \"accountHolder\": \"<string>\",\n  \"creditorId\": \"<string>\",\n  \"payPalEmailAddress\": \"<string>\",\n  \"isSmallBusinessOwner\": true,\n  \"dHLIntrashipCustomerId\": \"<string>\",\n  \"uPSCustomerId\": \"<string>\",\n  \"companyVatIdentifiers\": [\n    {\n      \"id\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n      \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n      \"countryIsoCode\": \"<string>\",\n      \"vatIdentifier\": \"<string>\",\n      \"isShippingCountry\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/companies/{companyId}")

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

request = Net::HTTP::Patch.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"companyName\": \"<string>\",\n  \"owner\": \"<string>\",\n  \"street\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"city\": \"<string>\",\n  \"country\": \"<string>\",\n  \"countryIsoCode\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"fax\": \"<string>\",\n  \"emailAddress\": \"<string>\",\n  \"website\": \"<string>\",\n  \"bankCode\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"bankName\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"iBAN\": \"<string>\",\n  \"bIC\": \"<string>\",\n  \"accountHolder\": \"<string>\",\n  \"creditorId\": \"<string>\",\n  \"payPalEmailAddress\": \"<string>\",\n  \"isSmallBusinessOwner\": true,\n  \"dHLIntrashipCustomerId\": \"<string>\",\n  \"uPSCustomerId\": \"<string>\",\n  \"companyVatIdentifiers\": [\n    {\n      \"id\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n      \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n      \"countryIsoCode\": \"<string>\",\n      \"vatIdentifier\": \"<string>\",\n      \"isShippingCountry\": true\n    }\n  ]\n}"

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

{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "companyName": "<string>",
  "owner": "<string>",
  "street": "<string>",
  "postalCode": "<string>",
  "city": "<string>",
  "country": "<string>",
  "countryIsoCode": "<string>",
  "phone": "<string>",
  "fax": "<string>",
  "emailAddress": "<string>",
  "website": "<string>",
  "bankCode": "<string>",
  "accountNumber": "<string>",
  "bankName": "<string>",
  "taxId": "<string>",
  "iBAN": "<string>",
  "bIC": "<string>",
  "accountHolder": "<string>",
  "creditorId": "<string>",
  "payPalEmailAddress": "<string>",
  "isSmallBusinessOwner": true,
  "dHLIntrashipCustomerId": "<string>",
  "uPSCustomerId": "<string>",
  "companyVatIdentifiers": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "countryIsoCode": "<string>",
      "vatIdentifier": "<string>",
      "isShippingCountry": true
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-companyid

string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

x-tenant-id

string<uuid>

required

The tenant ID for the target ERP instance.

Path Parameters

companyId

string<uuid>

required

Represents a key for identifying a firm within the application.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Body

application/json

Request parameters

A command to modify an existing company, including identification, contact, banking, and tax information. - Request

companyName

string

The name of the company.

owner

string

The owner of the company.

street

string

The street address of the company.

postalCode

string

The postal code of the company.

city

string

The city of the company.

country

string

The country name of the company.

countryIsoCode

string

The country ISO code of the company.

phone

string

The phone number of the company.

fax

string

The fax number of the company.

emailAddress

string

The email address of the company.

website

string

The website URL of the company.

bankCode

string

The bank code of the company.

accountNumber

string

The bank account number of the company.

bankName

string

The bank name of the company.

taxId

string

The tax identification number of the company.

iBAN

string

The International Bank Account Number (IBAN) of the company.

bIC

string

The Bank Identifier Code (BIC) of the company.

accountHolder

string

The account holder name of the company.

creditorId

string

The creditor ID for SEPA direct debit.

payPalEmailAddress

string

The PayPal email address of the company.

isSmallBusinessOwner

boolean

A value indicating whether the owner of the company is a small business owner (Kleinunternehmer). This affects the VAT handling of the company.

dHLIntrashipCustomerId

string

The DHL Intraship customer ID of the company.

uPSCustomerId

string

The UPS customer ID of the company.

companyVatIdentifiers

object[]

The collection of VAT identifiers for this company. When provided, replaces all existing VAT identifiers.

Show child attributes

Response

Company was successfully modified

A command to modify an existing company, including identification, contact, banking, and tax information. - Response

string<uuid>

required

Unique ID of the modified company.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

companyName

string

required

Name of the company.

owner

string

required

Owner of the company.

street

string

required

Street address of the company.

postalCode

string

required

Postal code of the company.

city

string

required

City of the company.

country

string

required

Country of the company.

countryIsoCode

string

required

Country ISO code.

phone

string

required

Phone number of the company.

fax

string

required

Fax number of the company.

emailAddress

string

required

Email address of the company.

website

string

required

Website of the company.

bankCode

string

required

Bank code.

accountNumber

string

required

Bank account number.

bankName

string

required

Name of the bank.

taxId

string

required

Tax identification number.

iBAN

string

required

International Bank Account Number.

bIC

string

required

Bank Identifier Code.

accountHolder

string

required

Bank account holder name.

creditorId

string

required

Creditor identification number.

payPalEmailAddress

string

required

PayPal email address of the company.

isSmallBusinessOwner

boolean

required

Indicates if the company is a small business owner.

dHLIntrashipCustomerId

string

required

DHL Intraship customer Id for shipping.

uPSCustomerId

string

required

UPS customer Id for shipping.

companyVatIdentifiers

object[]

required

List of company VAT identifiers.

Show child attributes

⌘I

Overview

GraphQL

REST API

A command to modify an existing company, including identification, contact, banking, and tax information.

Authorizations

Headers

Path Parameters

Body

Response