POST
/
tenants
curl -X POST \
 /tenants \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "name": "ACME Inc.",
    "legalCompanyName": "ACME Inc.",
    "username": "acme-inc"
}'
{
  "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
  "name": "ACME",
  "username": "acme",
  "vatNumber": "DE123456789",
  "owner": "<any>",
  "legalCompanyName": "Acme Inc.",
  "city": "Cologne",
  "zip": "50667",
  "street": "Domstraße",
  "housenumber": "1",
  "countryCode": "DE",
  "website": "https://acme.com",
  "commercialRegister": "Berlin Charlottenburg",
  "commercialRegisterNumber": "HRB 123456",
  "phone": "+49 123 456 789",
  "email": "info@acme.de",
  "ceo": "Max Mustermann",
  "iban": "DE89370400440532013000",
  "environment": "sandbox",
  "appearance": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "logoUrl": "https://example.com/logo.png",
    "primaryColor": "#000000",
    "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": {
    "id": "<string>",
    "logoPosition": "<any>",
    "footer": {
      "id": "<string>",
      "translations": {}
    }
  },
  "timeZone": "Europe/Berlin",
  "readOnlyCustomers": true,
  "createdAt": "2021-01-01T00:00:00+00:00",
  "updatedAt": "2021-01-01T00:00:00+00:00"
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Body

The new Tenant resource
​
name
string
required

The name of the tenant

Required string length: 2 - 255
Example:

"ACME Inc."

​
legalCompanyName
string
required

The legal company name of the tenant

Required string length: 2 - 255
Example:

"ACME Inc."

​
username
string
required

The username of the tenant

Required string length: 2 - 255
Example:

"acme-inc"

Response

201
application/json
Tenant resource created
​
name
string
required

The name of the tenant

Required string length: 2 - 255
Example:

"ACME"

​
legalCompanyName
string
required
Example:

"Acme Inc."

​
commercialRegister
string | null
required
Example:

"Berlin Charlottenburg"

​
commercialRegisterNumber
string | null
required
Example:

"HRB 123456"

​
id
string
Example:

"01F9Z3ZJXZQZJZJZJZJZJZJZJZ"

​
username
string
Example:

"acme"

​
vatNumber
string | null
Example:

"DE123456789"

​
owner
any
​
city
string
Example:

"Cologne"

​
zip
string
Example:

"50667"

​
street
string
Example:

"Domstraße"

​
housenumber
string
Example:

"1"

​
countryCode
string
Example:

"DE"

​
website
string | null
Example:

"https://acme.com"

​
phone
string | null
Example:

"+49 123 456 789"

​
email
string
Example:

"info@acme.de"

​
ceo
string | null
Example:

"Max Mustermann"

​
iban
string

The IBAN will be displayed on the invoice

Example:

"DE89370400440532013000"

​
environment
enum<string>
Available options:
sandbox,
production
​
appearance
object | null
​
documentSettings
object | null
​
timeZone
string
default:Europe/Berlin
Example:

"Europe/Berlin"

​
readOnlyCustomers
boolean

If true, customers are read-only in the frontend

​
createdAt
string

The date and time when the resource was created.

Example:

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

​
updatedAt
string

The date and time when the resource was last updated.

Example:

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

Was this page helpful?

Suggest editsRaise issue