Skip to main content
GET
cURL
Convert a silo entry’s GOBL envelope into an external format, such as UBL or CII, and download the result. Nothing is stored: to keep the converted document as one of the entry’s files, use the silo.export workflow action instead. Choose formats by their key from the conversion formats endpoint, escaping each + as %2B. List several in order of preference and the first that accepts the document is used. The GOBL-Convert-Format response header names the format chosen. To embed the entry’s files in the exported document, set attachments to all, or to a single file category: format or attachment. Use mime to limit them to particular types:

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

UUID of the silo entry to export.

Example:

"347c5b04-cde2-11ed-afa1-0242ac120002"

Query Parameters

format
string[]
required

Key of the format to export to, as listed by /gobl/convert/formats. Repeat the parameter, or separate keys with commas, to offer several in order of preference: the first that accepts the document is used.

Example:
attachments
enum<string>

Category of the entry's files to embed in the exported document. None are embedded when omitted.

Available options:
all,
format,
attachment
mime
string[]

Only embed files of these MIME types, any when omitted.

Example:

Response

200 - application/octet-stream

The exported document. Content type and disposition are set according to the format.

The response is of type file.