E-e-invoice-be
Admin

Create Tenant

Changed on
post/api/admin/tenants

Request

Request body

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

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

Example request

{
  "company_tax_id": "BE1018265814",
  "company_name": "E-INVOICE BV",
  "company_zip": "1980",
  "company_city": "Zemst",
  "company_country": "Belgium",
  "company_email": "info@e-invoice.be"
}

Response

Successful Response

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

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
enrollment_state'not_required' | 'not_enrolled' | 'pending' | 'enrolled' | 'failed'

Tenant-scoped enrollment process state for its Route's partner (ADR 0007).

not_required for peppol-direct (every existing tenant); partner routes start at not_enrolled and advance pending → enrolled or failed (with detail in status_message). We own this column; it is the process state, distinct from network-owned Publication.

status_messagestring nullable

Human-readable detail for the current enrollment_state, set when activation is failed.

route_overridestring nullable

If set, pins the delivery path used for this tenant's outbound documents instead of the default chosen from its country. Null means the default path is used.

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"
}

Changes

  • 0ee5e3d3992aRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1bb0867bdfdfRevision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property default value 999999999 was added

    • info

      the request property default value enterprise was added

    • info

      the response's property default value 999999999 was added for the status

    • info

      the response's property default value enterprise was added for the status