Skip to main content
PATCH
/
v2
/
company
/
change
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/company/change \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "companyId": "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
    }
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

​
x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

​
api-version
string
​
x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

​
x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
X-SessionId
string<uuid>

The id of a session in which the call will be executed.

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

Body

application/json

Request parameters

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

​
companyId
string<uuid>

The unique identifier of the company to modify.

Example:

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

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

Response

200 - application/json

Company was successfully modified