Skip to main content
POST
cURL
Convert a document in an external format, such as a UBL or CII invoice, into a GOBL Envelope without storing anything. Send the raw document as the request body. Its format is detected automatically, and the response says which one was used. Any files embedded in the document, such as a PDF copy of the invoice, are returned in attachments with their contents base64 encoded.
To limit detection to particular formats, pass their keys from the conversion formats endpoint in the format query parameter. To store the result as a new silo entry, use import an entry instead, which also keeps the original document and its attachments as files of the entry.

Authorizations

Authorization
string
header
required

Use the Bearer scheme with a valid JWT token to authenticate requests. Example: Authorization: Bearer <token>

Query Parameters

format
string[]

Keys of the formats to limit detection to. When omitted, the format is detected from the document.

Example:

Body

application/octet-stream

Raw document to import.

The body is of type file.

Response

200 - application/json

OK

attachments
Attachments · object[]

Files embedded in the document.

data
Data · object | null

GOBL Envelope built from the document.

format
string

Key of the format detected.

Example:

"ubl+peppol+bis-v3"