ParseHr

Parse HR — Peppol BIS 3.0 UBL (cross-border)

Parse a **HR — Peppol BIS 3.0 UBL (cross-border)** document. No pre-generated sample is shipped for this country/format yet — replace the `data` field with your own base64-encoded document before sending. Requires `e-invoice:hr:peppol-ubl:parse` entitlement.

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Request

This endpoint expects an object.
datastringRequired
Base64 encoded document (XML or PDF with embedded XML)
filenamestringOptional

Original filename (helps detect format)

Response

Invoice parsed successfully
successboolean
Whether parsing was successful
invoiceobjectOptional
Extracted invoice data
formatstringOptional

Detected format (e.g., ZUGFERD_EN16931)

hashstringOptional

SHA-256 hash of the input document

errorslist of objectsOptional

Parsing errors (if any)

warningslist of objectsOptional

Parsing warnings (if any)

infoslist of objectsOptional

Informational messages (e.g., XML extracted from PDF)

Errors

400
Peppol Ubl Hr Request Bad Request Error
401
Peppol Ubl Hr Request Unauthorized Error
403
Peppol Ubl Hr Request Forbidden Error
429
Peppol Ubl Hr Request Too Many Requests Error
500
Peppol Ubl Hr Request Internal Server Error