Partner Legal Entities

Manage legal entities on child tenants (Partner API only).

List legal entities on child tenant

GET /bizzlink/tenants/{tenantId}/legal-entities

List legal entities on child tenant

Responses:

Status	Description
`200`	Legal entity list
`403`	Not a partner or tenant not a child
`404`	Tenant not found

Response Body — JsonApiListDocumentLegalEntityResponseAttributes:

Field	Type	Description
`data`	`JsonApiResourceLegalEntityResponseAttributes[]`
`attributes`	`LegalEntityResponseAttributes`	Resource-specific fields.
`active`	`boolean`	Whether the legal entity is active.
`addressCity`	`string`	City.
`addressCountry`	`string`	Country code (ISO 3166-1 alpha-2).
`addressPostalCode`	`string`	Postal code.
`addressStreet`	`string`	Street address.
`contactEmail`	`string`	Contact email.
`contactName`	`string`	Contact person name.
`contactPhone`	`string`	Contact phone.
`createdAt`	`datetime`	Timestamp when created.
`customerName`	`string`	Legal entity name.
`legalEntityCode`	`string`	Legal entity code.
`tradeRegisterNumber`	`string`	Trade register number.
`updatedAt`	`datetime`	Timestamp of last update.
`vatNumber`	`string`	VAT number.
`id`	`string`	Unique resource identifier (UUID). Use this value to poll the status endpoint or to reference the resource in subsequent requests.
`type`	`string`	Resource type — matches the endpoint (e.g. 'invoices' for POST /documents/invoices, 'documents' for GET /documents/{id}/status).
`links`	`JsonApiLinks`
`first`	`string`	URL of the first page.
`last`	`string`	URL of the last page.
`next`	`string`	URL of the next page, null on last page.
`prev`	`string`	URL of the previous page, null on first page.
`self`	`string`	URL of the current page.
`meta`	`JsonApiPaginationMeta`
`page`	`integer`	1-based index of the current page.
`size`	`integer`	Number of items per page.
`totalElements`	`integer`	Total number of items across all pages.
`totalPages`	`integer`	Total number of pages.

cURL Request

curl -X GET https://gateway.vigasoft.lu/bizzlink/tenants/{tenantId}/legal-entities \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "X-Bizzlink-Signature: t=$TIMESTAMP,v1=$SIGNATURE"

Response
200 OK

{
    "data": [
    {
        "attributes": {
          "active": true,
          "addressCity": "string",
          "addressCountry": "LU",
          "addressPostalCode": "string",
          "addressStreet": "string",
          "contactEmail": "string",
          "contactName": "string",
          "contactPhone": "string",
          "createdAt": "2026-01-01T00:00:00Z",
          "customerName": "ACME Luxembourg S.A.",
          "legalEntityCode": "ACME-LU",
          "tradeRegisterNumber": "B123456",
          "updatedAt": "2026-01-01T00:00:00Z",
          "vatNumber": "LU12345678"
      },
        "id": "770e8400-e29b-41d4-a716-446655440000",
        "type": "invoices"
    }
    ],
    "links": {
      "first": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=1&page%5Bsize%5D=20",
      "last": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=7&page%5Bsize%5D=20",
      "next": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=4&page%5Bsize%5D=20",
      "prev": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=2&page%5Bsize%5D=20",
      "self": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=3&page%5Bsize%5D=20"
  },
    "meta": {
      "page": 1,
      "size": 20,
      "totalElements": 137,
      "totalPages": 7
  }
}

Create legal entity on child tenant

POST /bizzlink/tenants/{tenantId}/legal-entities

Create legal entity on child tenant

Request Body:

Field	Type	Required	Description
`data`	`object`	Yes	Resource envelope. 'attributes' holds the domain fields; 'meta.scope' declares whether the resource belongs to the whole tenant or to a specific legal entity (Peppol ID).
`attributes`	`LegalEntityCreateAttributes`	Yes	The actual resource fields.
`addressCity`	`string`	Yes	City.
`addressCountry`	`string`	Yes	ISO 3166-1 alpha-2 country code.
`addressPostalCode`	`string`	Yes	Postal code.
`addressStreet`	`string`	Yes	Street address.
`contactEmail`	`string`	Yes	Contact email.
`contactName`	`string`	No	Contact person name.
`contactPhone`	`string`	No	Contact phone.
`customerName`	`string`	Yes	Legal entity name.
`tradeRegisterNumber`	`string`	Yes	Trade register number.
`vatNumber`	`string`	No	VAT number.
`meta`	`JsonApiMeta`	No	Optional JSON:API meta. Only used by scoped resources (e.g. email templates, notification emails) to declare their ownership scope.
`scope`	`JsonApiScope`	Yes
`type`	`string`	Yes	Scope type. 'tenant' = applies to the whole tenant. 'legal-entity' = applies only to the Peppol ID given in 'value'. 'partner' = applies to all child tenants of the calling partner tenant; 'value' must be empty.
`value`	`string`	No	Required when type='legal-entity': the Peppol ID (scheme:identifier) that owns this resource, e.g. '9938:lu28079289'. Must belong to the requesting tenant. Ignored when type='tenant'. Must be empty when type='partner'.
`type`	`string`	No	Must be 'legal-entities' for this endpoint.

Responses:

Status	Description
`201`	Legal entity created
`403`	Not a partner or tenant not a child
`404`	Tenant not found

cURL Request

curl -X POST https://gateway.vigasoft.lu/bizzlink/tenants/{tenantId}/legal-entities \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "X-Bizzlink-Signature: t=$TIMESTAMP,v1=$SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{
      "data": {}
  }'

Update legal entity on child tenant

PATCH /bizzlink/tenants/{tenantId}/legal-entities/{leId}

Update legal entity on child tenant

Request Body:

Field	Type	Required	Description
`data`	`object`	Yes
`attributes`	`LegalEntityCreateAttributes`	Yes
`addressCity`	`string`	Yes	City.
`addressCountry`	`string`	Yes	ISO 3166-1 alpha-2 country code.
`addressPostalCode`	`string`	Yes	Postal code.
`addressStreet`	`string`	Yes	Street address.
`contactEmail`	`string`	Yes	Contact email.
`contactName`	`string`	No	Contact person name.
`contactPhone`	`string`	No	Contact phone.
`customerName`	`string`	Yes	Legal entity name.
`tradeRegisterNumber`	`string`	Yes	Trade register number.
`vatNumber`	`string`	No	VAT number.
`id`	`string`	No
`meta`	`JsonApiMeta`	No
`scope`	`JsonApiScope`	Yes
`type`	`string`	Yes	Scope type. 'tenant' = applies to the whole tenant. 'legal-entity' = applies only to the Peppol ID given in 'value'. 'partner' = applies to all child tenants of the calling partner tenant; 'value' must be empty.
`value`	`string`	No	Required when type='legal-entity': the Peppol ID (scheme:identifier) that owns this resource, e.g. '9938:lu28079289'. Must belong to the requesting tenant. Ignored when type='tenant'. Must be empty when type='partner'.
`type`	`string`	No	Must be 'legal-entities' for this endpoint.

Responses:

Status	Description
`200`	Legal entity updated
`403`	Not a partner or tenant not a child
`404`	Tenant or legal entity not found

Response Body — JsonApiDocumentLegalEntityResponseAttributes:

Field	Type	Description
`data`	`JsonApiResourceLegalEntityResponseAttributes`
`attributes`	`LegalEntityResponseAttributes`	Resource-specific fields.
`active`	`boolean`	Whether the legal entity is active.
`addressCity`	`string`	City.
`addressCountry`	`string`	Country code (ISO 3166-1 alpha-2).
`addressPostalCode`	`string`	Postal code.
`addressStreet`	`string`	Street address.
`contactEmail`	`string`	Contact email.
`contactName`	`string`	Contact person name.
`contactPhone`	`string`	Contact phone.
`createdAt`	`datetime`	Timestamp when created.
`customerName`	`string`	Legal entity name.
`legalEntityCode`	`string`	Legal entity code.
`tradeRegisterNumber`	`string`	Trade register number.
`updatedAt`	`datetime`	Timestamp of last update.
`vatNumber`	`string`	VAT number.
`id`	`string`	Unique resource identifier (UUID). Use this value to poll the status endpoint or to reference the resource in subsequent requests.
`type`	`string`	Resource type — matches the endpoint (e.g. 'invoices' for POST /documents/invoices, 'documents' for GET /documents/{id}/status).

cURL Request

curl -X PATCH https://gateway.vigasoft.lu/bizzlink/tenants/{tenantId}/legal-entities/{leId} \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "X-Bizzlink-Signature: t=$TIMESTAMP,v1=$SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{
      "data": {}
  }'

Response
200 OK

{
    "data": {
      "attributes": {
        "active": true,
        "addressCity": "string",
        "addressCountry": "LU",
        "addressPostalCode": "string",
        "addressStreet": "string",
        "contactEmail": "string",
        "contactName": "string",
        "contactPhone": "string",
        "createdAt": "2026-01-01T00:00:00Z",
        "customerName": "ACME Luxembourg S.A.",
        "legalEntityCode": "ACME-LU",
        "tradeRegisterNumber": "B123456",
        "updatedAt": "2026-01-01T00:00:00Z",
        "vatNumber": "LU12345678"
    },
      "id": "770e8400-e29b-41d4-a716-446655440000",
      "type": "invoices"
  }
}