Responses

API response object reference.

All endpoints return one of these JSON:API response types.

JsonApiListDocumentDocumentAcceptedAttributes

Field	Type	Description
	`JsonApiResourceDocumentAcceptedAttributes[]`
	`DocumentAcceptedAttributes`	Resource-specific fields.
`format`	`string`	Wire format of the generated XML for this rendition.
`processId`	`uuid`	Correlation id shared by all renditions produced by the same create call. Use GET /documents?processId={uuid} to retrieve sibling renditions.
`status`	`string`	Status at the time of acknowledgement. Typically QUEUED_FOR_VALIDATION (awaiting async validation), VALID (when validation was skipped), or FAILED (on synchronous generation/conversion error).
`target`	`string`	Destination network/platform this rendition will be delivered to.
`xml`	`string`	Generated XML content in the indicated format. Present when generation succeeded.
`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).
	`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.
	`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.

JsonApiDocumentDocumentAttributes

Field	Type	Description
	`JsonApiResourceDocumentAttributes`
	`DocumentAttributes`	Resource-specific fields.
`acknowledgementStatus`	`string`	Acknowledgement outcome of a sent document: SUCCESS (AS4 receipt / positive MLS AP/AB) or FAILURE (send failure / negative MLS RE). Null until acknowledged.
`createdAt`	`datetime`	Timestamp when the document was first accepted.
	`ValidationError[]`	Validation errors. Populated after async Schematron validation completes with status INVALID. Null otherwise.
`flag`	`string`	Raw schematron severity flag id (e.g. fatal_error, warn)
`id`	`string`	Schematron rule ID
`location`	`string`	XPath location of the error in the XML
`severity`	`string`	Parsed severity; ERROR/FATAL_ERROR block sending, WARNING/INFO do not
`text`	`string`	Human-readable error message
`format`	`string`	Wire format of the stored XML.
`processId`	`uuid`	Correlation id shared by all renditions produced by the same create call. Use GET /documents?processId={uuid} to retrieve sibling renditions.
`status`	`string`	Processing status. Outbound lifecycle: ACCEPTED → QUEUED_FOR_VALIDATION → VALID/INVALID → QUEUED_FOR_SENDING → SUBMITTED → DELIVERED, or FAILED. Inbound documents use RECEIVED → READY_FOR_PICKUP → PICKED_UP, or INBOUND_FAILED.
`target`	`string`	Destination network/platform this rendition was/will be delivered to.
`updatedAt`	`datetime`	Timestamp of the most recent state change.
`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).

JsonApiDocumentValidationResultAttributes

Field	Type	Description
	`JsonApiResourceValidationResultAttributes`
	`ValidationResultAttributes`	Resource-specific fields.
	`ValidationError[]`	List of validation errors (empty if valid).
`flag`	`string`	Raw schematron severity flag id (e.g. fatal_error, warn)
`id`	`string`	Schematron rule ID
`location`	`string`	XPath location of the error in the XML
`severity`	`string`	Parsed severity; ERROR/FATAL_ERROR block sending, WARNING/INFO do not
`text`	`string`	Human-readable error message
`valid`	`boolean`	Whether the XML passed Schematron validation.
`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).

JsonApiDocumentTenantResponseAttributes

Field	Type	Description
	`JsonApiResourceTenantResponseAttributes`
	`TenantResponseAttributes`	Resource-specific fields.
`active`	`boolean`	Whether the tenant is active.
`addressCity`	`string`	City.
`addressCountry`	`string`	Country code (ISO 3166-1 alpha-2).
`addressPostalCode`	`string`	Postal code.
`addressStreet`	`string`	Street address.
`billingModel`	`string`	Billing model assigned to this tenant.
`companyName`	`string`	Company name.
`contactEmail`	`string`	Contact email.
`contactName`	`string`	Contact person name.
`contactPhone`	`string`	Contact phone.
`createdAt`	`datetime`	Timestamp when the tenant was created.
`tenantCode`	`string`	Unique tenant code.
`updatedAt`	`datetime`	Timestamp of last update.
`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).

JsonApiListDocumentTenantResponseAttributes

Field	Type	Description
	`JsonApiResourceTenantResponseAttributes[]`
	`TenantResponseAttributes`	Resource-specific fields.
`active`	`boolean`	Whether the tenant is active.
`addressCity`	`string`	City.
`addressCountry`	`string`	Country code (ISO 3166-1 alpha-2).
`addressPostalCode`	`string`	Postal code.
`addressStreet`	`string`	Street address.
`billingModel`	`string`	Billing model assigned to this tenant.
`companyName`	`string`	Company name.
`contactEmail`	`string`	Contact email.
`contactName`	`string`	Contact person name.
`contactPhone`	`string`	Contact phone.
`createdAt`	`datetime`	Timestamp when the tenant was created.
`tenantCode`	`string`	Unique tenant code.
`updatedAt`	`datetime`	Timestamp of last update.
`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).
	`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.
	`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.

JsonApiDocumentLegalEntityResponseAttributes

Field	Type	Description
	`JsonApiResourceLegalEntityResponseAttributes`
	`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).

JsonApiListDocumentLegalEntityResponseAttributes

Field	Type	Description
	`JsonApiResourceLegalEntityResponseAttributes[]`
	`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).
	`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.
	`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.

JsonApiDocumentPeppolIdResponseAttributes

Field	Type	Description
	`JsonApiResourcePeppolIdResponseAttributes`
	`PeppolIdResponseAttributes`	Resource-specific fields.
`active`	`boolean`	Whether the Peppol ID is active.
`bcAdditionalIdScheme`	`string`	Business card additional identifier scheme; null = 'bizzlink.lu'.
`bcAdditionalIdValue`	`string`	Business card additional identifier value; null = legal entity VAT.
`bcAdditionalInformation`	`string`	Business card free-text AdditionalInformation (developer-chosen via API; 'bizzlink.lu' for UI-managed).
`bcCountryCode`	`string`	Business card country (ISO 3166-1 alpha-2); null = legal entity default.
`bcGeographicalInfo`	`string`	Business card geographical information; null = legal entity default.
`bcName`	`string`	Business card name (Peppol Directory); null = legal entity default.
`bcRegistrationDate`	`date`	Business card registration date (ISO date); null = Peppol ID creation date.
`createdAt`	`datetime`	Timestamp when created.
`description`	`string`	Description.
`isDefault`	`boolean`	Whether this is the default Peppol ID for the legal entity.
`participantId`	`string`	Participant identifier.
`peppolId`	`string`	Full Peppol ID (schemeId:participantId).
`schemeId`	`string`	ISO 6523 ICD code.
`smpRegistered`	`boolean`	Whether registered in SMP.
`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).

JsonApiListDocumentPeppolIdResponseAttributes

Field	Type	Description
	`JsonApiResourcePeppolIdResponseAttributes[]`
	`PeppolIdResponseAttributes`	Resource-specific fields.
`active`	`boolean`	Whether the Peppol ID is active.
`bcAdditionalIdScheme`	`string`	Business card additional identifier scheme; null = 'bizzlink.lu'.
`bcAdditionalIdValue`	`string`	Business card additional identifier value; null = legal entity VAT.
`bcAdditionalInformation`	`string`	Business card free-text AdditionalInformation (developer-chosen via API; 'bizzlink.lu' for UI-managed).
`bcCountryCode`	`string`	Business card country (ISO 3166-1 alpha-2); null = legal entity default.
`bcGeographicalInfo`	`string`	Business card geographical information; null = legal entity default.
`bcName`	`string`	Business card name (Peppol Directory); null = legal entity default.
`bcRegistrationDate`	`date`	Business card registration date (ISO date); null = Peppol ID creation date.
`createdAt`	`datetime`	Timestamp when created.
`description`	`string`	Description.
`isDefault`	`boolean`	Whether this is the default Peppol ID for the legal entity.
`participantId`	`string`	Participant identifier.
`peppolId`	`string`	Full Peppol ID (schemeId:participantId).
`schemeId`	`string`	ISO 6523 ICD code.
`smpRegistered`	`boolean`	Whether registered in SMP.
`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).
	`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.
	`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.

JsonApiDocumentParticipantLookupAttributes

Field	Type	Description
	`JsonApiResourceParticipantLookupAttributes`
	`ParticipantLookupAttributes`	Resource-specific fields.
`country`	`string`	ISO 3166-1 alpha-2 country code from the Peppol Directory Business Card. `null` when no Business Card is available.
`documentTypes`	`string[]`	Distinct Peppol document type identifiers the participant accepts (union across PROD and TEST). Each entry is the full URL-decoded ID, e.g. `busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1`.
`environment`	`string[]`	Which Peppol networks the participant is registered on. Possible entries: `PROD` (live network — SML `edelivery.tech.ec.europa.eu`), `TEST` (acceptance network — SML `acc.edelivery.tech.ec.europa.eu`). Empty when `registered=false`.
`name`	`string`	Official company name from the Peppol Directory Business Card (if the SMP publishes one). `null` when no Business Card is available.
`registered`	`boolean`	Whether the participant is registered on at least one Peppol network (PROD or TEST).
`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).

JsonApiScopedDocumentWebhookAttributes

Field	Type	Description
	`JsonApiScopedResourceWebhookAttributes`
	`WebhookAttributes`	Resource-specific fields.
`chainEnabled`	`boolean`
`createdAt`	`datetime`
`enabled`	`boolean`
`environment`	`string`
`events`	`string[]`
`secret`	`string`
`updatedAt`	`datetime`
`url`	`string`
`id`	`string`	Unique resource identifier (UUID).
	`JsonApiMeta`	Resource-level meta object carrying the ownership scope (tenant vs legal-entity).
required	`JsonApiScope`
`type`required	`string`	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`	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`	Resource type — matches the endpoint (e.g. 'email-templates', 'notification-emails').

JsonApiScopedListDocumentWebhookAttributes

Field	Type	Description
	`JsonApiScopedResourceWebhookAttributes[]`
	`WebhookAttributes`	Resource-specific fields.
`chainEnabled`	`boolean`
`createdAt`	`datetime`
`enabled`	`boolean`
`environment`	`string`
`events`	`string[]`
`secret`	`string`
`updatedAt`	`datetime`
`url`	`string`
`id`	`string`	Unique resource identifier (UUID).
	`JsonApiMeta`	Resource-level meta object carrying the ownership scope (tenant vs legal-entity).
required	`JsonApiScope`
`type`required	`string`	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`	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`	Resource type — matches the endpoint (e.g. 'email-templates', 'notification-emails').
	`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.
	`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.

JsonApiScopedDocumentEmailTemplateAttributes

Field	Type	Description
	`JsonApiScopedResourceEmailTemplateAttributes`
	`EmailTemplateAttributes`	Resource-specific fields.
`content`	`string`
`createdAt`	`datetime`
`name`	`string`
`subject`	`string`
`updatedAt`	`datetime`
`id`	`string`	Unique resource identifier (UUID).
	`JsonApiMeta`	Resource-level meta object carrying the ownership scope (tenant vs legal-entity).
required	`JsonApiScope`
`type`required	`string`	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`	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`	Resource type — matches the endpoint (e.g. 'email-templates', 'notification-emails').

JsonApiScopedListDocumentEmailTemplateAttributes

Field	Type	Description
	`JsonApiScopedResourceEmailTemplateAttributes[]`
	`EmailTemplateAttributes`	Resource-specific fields.
`content`	`string`
`createdAt`	`datetime`
`name`	`string`
`subject`	`string`
`updatedAt`	`datetime`
`id`	`string`	Unique resource identifier (UUID).
	`JsonApiMeta`	Resource-level meta object carrying the ownership scope (tenant vs legal-entity).
required	`JsonApiScope`
`type`required	`string`	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`	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`	Resource type — matches the endpoint (e.g. 'email-templates', 'notification-emails').
	`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.
	`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.

WebhookTestResponse

Field	Type	Description
`httpStatus`	`integer`
`message`	`string`
`success`	`boolean`

ValidationError

Schematron validation error detail

Field	Type	Description
`flag`	`string`	Raw schematron severity flag id (e.g. fatal_error, warn)
`id`	`string`	Schematron rule ID
`location`	`string`	XPath location of the error in the XML
`severity`	`string`	Parsed severity; ERROR/FATAL_ERROR block sending, WARNING/INFO do not
`text`	`string`	Human-readable error message

PingResponse

Field	Type	Description
`environment`	`string`
`role`	`string`
`status`	`string`
`timestamp`	`datetime`