Update a tenant

curl --request PATCH \
  --url https://coreapi.io/tenants/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '
{
  "name": "ACME",
  "legalCompanyName": "Acme Inc.",
  "commercialRegister": "Berlin Charlottenburg",
  "commercialRegisterNumber": "HRB 123456",
  "vatNumber": "DE123456789",
  "city": "Cologne",
  "zip": "50667",
  "street": "Domstraße",
  "housenumber": "1",
  "countryCode": "DE",
  "website": "https://acme.com",
  "phone": "+49 123 456 789",
  "email": "info@acme.de",
  "ceo": "Max Mustermann",
  "iban": "DE89370400440532013000",
  "appearance": {
    "primaryColor": "#000000",
    "logoUrl": "https://example.com/logo.png",
    "secondaryColor": "#000000",
    "privacyUrl": "https://example.com/privacy",
    "conditionsUrl": "https://example.com/terms-and-conditions"
  },
  "documentSettings": {
    "logoPosition": "left",
    "footer": {
      "translations": {}
    }
  },
  "readOnlyCustomers": true
}
'

import requests

url = "https://coreapi.io/tenants/{id}"

payload = {
    "name": "ACME",
    "legalCompanyName": "Acme Inc.",
    "commercialRegister": "Berlin Charlottenburg",
    "commercialRegisterNumber": "HRB 123456",
    "vatNumber": "DE123456789",
    "city": "Cologne",
    "zip": "50667",
    "street": "Domstraße",
    "housenumber": "1",
    "countryCode": "DE",
    "website": "https://acme.com",
    "phone": "+49 123 456 789",
    "email": "info@acme.de",
    "ceo": "Max Mustermann",
    "iban": "DE89370400440532013000",
    "appearance": {
        "primaryColor": "#000000",
        "logoUrl": "https://example.com/logo.png",
        "secondaryColor": "#000000",
        "privacyUrl": "https://example.com/privacy",
        "conditionsUrl": "https://example.com/terms-and-conditions"
    },
    "documentSettings": {
        "logoPosition": "left",
        "footer": { "translations": {} }
    },
    "readOnlyCustomers": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/merge-patch+json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/merge-patch+json'
  },
  body: JSON.stringify({
    name: 'ACME',
    legalCompanyName: 'Acme Inc.',
    commercialRegister: 'Berlin Charlottenburg',
    commercialRegisterNumber: 'HRB 123456',
    vatNumber: 'DE123456789',
    city: 'Cologne',
    zip: '50667',
    street: 'Domstraße',
    housenumber: '1',
    countryCode: 'DE',
    website: 'https://acme.com',
    phone: '+49 123 456 789',
    email: 'info@acme.de',
    ceo: 'Max Mustermann',
    iban: 'DE89370400440532013000',
    appearance: {
      primaryColor: '#000000',
      logoUrl: 'https://example.com/logo.png',
      secondaryColor: '#000000',
      privacyUrl: 'https://example.com/privacy',
      conditionsUrl: 'https://example.com/terms-and-conditions'
    },
    documentSettings: {logoPosition: 'left', footer: {translations: {}}},
    readOnlyCustomers: true
  })
};

fetch('https://coreapi.io/tenants/{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://coreapi.io/tenants/{id}",
  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([
    'name' => 'ACME',
    'legalCompanyName' => 'Acme Inc.',
    'commercialRegister' => 'Berlin Charlottenburg',
    'commercialRegisterNumber' => 'HRB 123456',
    'vatNumber' => 'DE123456789',
    'city' => 'Cologne',
    'zip' => '50667',
    'street' => 'Domstraße',
    'housenumber' => '1',
    'countryCode' => 'DE',
    'website' => 'https://acme.com',
    'phone' => '+49 123 456 789',
    'email' => 'info@acme.de',
    'ceo' => 'Max Mustermann',
    'iban' => 'DE89370400440532013000',
    'appearance' => [
        'primaryColor' => '#000000',
        'logoUrl' => 'https://example.com/logo.png',
        'secondaryColor' => '#000000',
        'privacyUrl' => 'https://example.com/privacy',
        'conditionsUrl' => 'https://example.com/terms-and-conditions'
    ],
    'documentSettings' => [
        'logoPosition' => 'left',
        'footer' => [
                'translations' => [
                                
                ]
        ]
    ],
    'readOnlyCustomers' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/merge-patch+json"
  ],
]);

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

curl_close($curl);

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

{
  "name": "ACME",
  "legalCompanyName": "Acme Inc.",
  "commercialRegister": "Berlin Charlottenburg",
  "commercialRegisterNumber": "HRB 123456",
  "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
  "username": "acme",
  "vatNumber": "DE123456789",
  "owner": "<unknown>",
  "city": "Cologne",
  "zip": "50667",
  "street": "Domstraße",
  "housenumber": "1",
  "countryCode": "DE",
  "website": "https://acme.com",
  "phone": "+49 123 456 789",
  "email": "info@acme.de",
  "ceo": "Max Mustermann",
  "iban": "DE89370400440532013000",
  "appearance": {
    "primaryColor": "#000000",
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "logoUrl": "https://example.com/logo.png",
    "secondaryColor": "#000000",
    "privacyUrl": "https://example.com/privacy",
    "conditionsUrl": "https://example.com/terms-and-conditions",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "documentSettings": {
    "logoPosition": "left",
    "id": "<string>",
    "footer": {
      "translations": {},
      "id": "<string>"
    }
  },
  "timeZone": "Europe/Berlin",
  "readOnlyCustomers": true,
  "createdAt": "2021-01-01T00:00:00+00:00",
  "updatedAt": "2021-01-01T00:00:00+00:00"
}

PATCH

tenants

{id}

Update a tenant

curl --request PATCH \
  --url https://coreapi.io/tenants/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '
{
  "name": "ACME",
  "legalCompanyName": "Acme Inc.",
  "commercialRegister": "Berlin Charlottenburg",
  "commercialRegisterNumber": "HRB 123456",
  "vatNumber": "DE123456789",
  "city": "Cologne",
  "zip": "50667",
  "street": "Domstraße",
  "housenumber": "1",
  "countryCode": "DE",
  "website": "https://acme.com",
  "phone": "+49 123 456 789",
  "email": "info@acme.de",
  "ceo": "Max Mustermann",
  "iban": "DE89370400440532013000",
  "appearance": {
    "primaryColor": "#000000",
    "logoUrl": "https://example.com/logo.png",
    "secondaryColor": "#000000",
    "privacyUrl": "https://example.com/privacy",
    "conditionsUrl": "https://example.com/terms-and-conditions"
  },
  "documentSettings": {
    "logoPosition": "left",
    "footer": {
      "translations": {}
    }
  },
  "readOnlyCustomers": true
}
'

import requests

url = "https://coreapi.io/tenants/{id}"

payload = {
    "name": "ACME",
    "legalCompanyName": "Acme Inc.",
    "commercialRegister": "Berlin Charlottenburg",
    "commercialRegisterNumber": "HRB 123456",
    "vatNumber": "DE123456789",
    "city": "Cologne",
    "zip": "50667",
    "street": "Domstraße",
    "housenumber": "1",
    "countryCode": "DE",
    "website": "https://acme.com",
    "phone": "+49 123 456 789",
    "email": "info@acme.de",
    "ceo": "Max Mustermann",
    "iban": "DE89370400440532013000",
    "appearance": {
        "primaryColor": "#000000",
        "logoUrl": "https://example.com/logo.png",
        "secondaryColor": "#000000",
        "privacyUrl": "https://example.com/privacy",
        "conditionsUrl": "https://example.com/terms-and-conditions"
    },
    "documentSettings": {
        "logoPosition": "left",
        "footer": { "translations": {} }
    },
    "readOnlyCustomers": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/merge-patch+json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/merge-patch+json'
  },
  body: JSON.stringify({
    name: 'ACME',
    legalCompanyName: 'Acme Inc.',
    commercialRegister: 'Berlin Charlottenburg',
    commercialRegisterNumber: 'HRB 123456',
    vatNumber: 'DE123456789',
    city: 'Cologne',
    zip: '50667',
    street: 'Domstraße',
    housenumber: '1',
    countryCode: 'DE',
    website: 'https://acme.com',
    phone: '+49 123 456 789',
    email: 'info@acme.de',
    ceo: 'Max Mustermann',
    iban: 'DE89370400440532013000',
    appearance: {
      primaryColor: '#000000',
      logoUrl: 'https://example.com/logo.png',
      secondaryColor: '#000000',
      privacyUrl: 'https://example.com/privacy',
      conditionsUrl: 'https://example.com/terms-and-conditions'
    },
    documentSettings: {logoPosition: 'left', footer: {translations: {}}},
    readOnlyCustomers: true
  })
};

fetch('https://coreapi.io/tenants/{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://coreapi.io/tenants/{id}",
  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([
    'name' => 'ACME',
    'legalCompanyName' => 'Acme Inc.',
    'commercialRegister' => 'Berlin Charlottenburg',
    'commercialRegisterNumber' => 'HRB 123456',
    'vatNumber' => 'DE123456789',
    'city' => 'Cologne',
    'zip' => '50667',
    'street' => 'Domstraße',
    'housenumber' => '1',
    'countryCode' => 'DE',
    'website' => 'https://acme.com',
    'phone' => '+49 123 456 789',
    'email' => 'info@acme.de',
    'ceo' => 'Max Mustermann',
    'iban' => 'DE89370400440532013000',
    'appearance' => [
        'primaryColor' => '#000000',
        'logoUrl' => 'https://example.com/logo.png',
        'secondaryColor' => '#000000',
        'privacyUrl' => 'https://example.com/privacy',
        'conditionsUrl' => 'https://example.com/terms-and-conditions'
    ],
    'documentSettings' => [
        'logoPosition' => 'left',
        'footer' => [
                'translations' => [
                                
                ]
        ]
    ],
    'readOnlyCustomers' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/merge-patch+json"
  ],
]);

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

curl_close($curl);

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

{
  "name": "ACME",
  "legalCompanyName": "Acme Inc.",
  "commercialRegister": "Berlin Charlottenburg",
  "commercialRegisterNumber": "HRB 123456",
  "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
  "username": "acme",
  "vatNumber": "DE123456789",
  "owner": "<unknown>",
  "city": "Cologne",
  "zip": "50667",
  "street": "Domstraße",
  "housenumber": "1",
  "countryCode": "DE",
  "website": "https://acme.com",
  "phone": "+49 123 456 789",
  "email": "info@acme.de",
  "ceo": "Max Mustermann",
  "iban": "DE89370400440532013000",
  "appearance": {
    "primaryColor": "#000000",
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "logoUrl": "https://example.com/logo.png",
    "secondaryColor": "#000000",
    "privacyUrl": "https://example.com/privacy",
    "conditionsUrl": "https://example.com/terms-and-conditions",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "documentSettings": {
    "logoPosition": "left",
    "id": "<string>",
    "footer": {
      "translations": {},
      "id": "<string>"
    }
  },
  "timeZone": "Europe/Berlin",
  "readOnlyCustomers": true,
  "createdAt": "2021-01-01T00:00:00+00:00",
  "updatedAt": "2021-01-01T00:00:00+00:00"
}

Autorisierungen

Authorization

string

header

erforderlich

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

Pfadparameter

string

erforderlich

Tenant identifier

Body

The updated Tenant resource

name

string

erforderlich

The name of the tenant

Required string length: 2 - 255

Beispiel:

"ACME"

legalCompanyName

string

erforderlich

Beispiel:

"Acme Inc."

commercialRegister

string | null

erforderlich

Beispiel:

"Berlin Charlottenburg"

commercialRegisterNumber

string | null

erforderlich

Beispiel:

"HRB 123456"

vatNumber

string | null

Beispiel:

"DE123456789"

city

string

Beispiel:

"Cologne"

zip

string

Beispiel:

"50667"

street

string

Beispiel:

"Domstraße"

housenumber

string

Beispiel:

"1"

countryCode

string

Beispiel:

"DE"

website

string | null

Beispiel:

"https://acme.com"

phone

string | null

Beispiel:

"+49 123 456 789"

string

Beispiel:

"info@acme.de"

ceo

string | null

Beispiel:

"Max Mustermann"

iban

string

The IBAN will be displayed on the invoice

Beispiel:

"DE89370400440532013000"

appearance

object | null

Show child attributes

documentSettings

object | null

Show child attributes

readOnlyCustomers

boolean

If true, customers are read-only in the frontend

Antwort

Tenant resource updated

name

string

erforderlich

The name of the tenant

Required string length: 2 - 255

Beispiel:

"ACME"

legalCompanyName

string

erforderlich

Beispiel:

"Acme Inc."

commercialRegister

string | null

erforderlich

Beispiel:

"Berlin Charlottenburg"

commercialRegisterNumber

string | null

erforderlich

Beispiel:

"HRB 123456"

string

read-only

Beispiel:

"01F9Z3ZJXZQZJZJZJZJZJZJZJZ"

username

string

read-only

Beispiel:

"acme"

vatNumber

string | null

Beispiel:

"DE123456789"

owner

any

read-only

city

string

Beispiel:

"Cologne"

zip

string

Beispiel:

"50667"

street

string

Beispiel:

"Domstraße"

housenumber

string

Beispiel:

"1"

countryCode

string

Beispiel:

"DE"

website

string | null

Beispiel:

"https://acme.com"

phone

string | null

Beispiel:

"+49 123 456 789"

string

Beispiel:

"info@acme.de"

ceo

string | null

Beispiel:

"Max Mustermann"

iban

string

The IBAN will be displayed on the invoice

Beispiel:

"DE89370400440532013000"

environment

enum<string>

read-only

Verfügbare Optionen:

sandbox,

production

appearance

object | null

Show child attributes

documentSettings

object | null

Show child attributes

timeZone

string

Standard:Europe/Berlin

read-only

Beispiel:

"Europe/Berlin"

readOnlyCustomers

boolean

If true, customers are read-only in the frontend

createdAt

string<date-time>

read-only

The date and time when the resource was created.

Beispiel:

"2021-01-01T00:00:00+00:00"

updatedAt

string<date-time>

read-only

The date and time when the resource was last updated.

Beispiel:

"2021-01-01T00:00:00+00:00"

Get a tenant Get the tenants of the current user

API documentation

User

Tenant

Customer

Catalogue

Subscription

Invoice

Payment

Dunning

Offer

Checkout

Feature & Entitlement

Analytics

Accounting

Settings

Update a tenant

Autorisierungen

Pfadparameter

Body

Antwort