Skip to main content
POST
/
build
Build a GOBL document
curl --request POST \
  --url https://gobl.dev/v0/build \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": "<unknown>",
  "template": "<unknown>",
  "type": "<string>",
  "envelop": false
}
'
{
  "code": 422,
  "key": "<string>",
  "message": "<string>",
  "faults": [
    {
      "properties": [
        "<string>"
      ],
      "description": "<string>"
    }
  ]
}

Body

application/json
data
any
required

GOBL document to build.

template
any

Optional template to merge with the data before building.

type
string

Document type hint (e.g. bill/invoice).

envelop
boolean
default:false

Wrap the result in an envelope.

Response

Built document or envelope