Sign in

v24

latestOpenAPI 3.1.0raw.githubusercontent.com2025-12-1152106250.5 KB
Admin

Get Tenant

get/api/admin/tenants/{tenant_id}

Path parameters

tenant_idstring required

Response

Successful Response

namestring required
descriptionstring nullable
plan'starter' | 'pro' | 'enterprise' required
credit_balanceinteger required

Credit balance of the tenant

peppol_idsstring[] nullable

Peppol IDs of the tenant

ibansstring[] nullable

IBANs of the tenant

company_numberstring nullable

Company number. For Belgium this is the CBE number or their EUID (European Unique Identifier) number

company_tax_idstring nullable

Company tax ID. For Belgium this is the VAT number. Must include the country prefix

company_namestring nullable

Name of the company. Must include the company type. For example: BV, NV, CVBA, VOF

company_addressstring nullable

Address of the company. Must be in the form of Street Name Street Number

company_zipstring nullable

Zip code of the company

company_citystring nullable

City of the company

company_countrystring nullable

Country of the company

company_emailstring nullable

Email of the company

smp_registrationboolean nullable

Whether the tenant is registered on our SMP

smp_registration_datestring date-time nullable

Date when the tenant was registered on SMP

bcc_recipient_emailstring nullable

BCC recipient email to deliver documents

idstring required
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "company_number": "1018265814",
  "company_tax_id": "BE1018265814",
  "company_name": "E-INVOICE BV",
  "company_address": "Brusselsesteenweg 119/A",
  "company_zip": "1980",
  "company_city": "Zemst",
  "company_country": "Belgium",
  "company_email": "info@e-invoice.be"
}