Create a corrective document

Generates a credit note, debit note, or other correction from an existing document. When the schema flag is set, returns the available correction options instead.

POST /correct

Create a corrective document

cURL

curl --request POST \
  --url https://gobl.dev/v0/correct \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": "<unknown>",
  "options": "<unknown>",
  "schema": false
}
'

400

{
  "code": 422,
  "key": "<string>",
  "message": "<string>",
  "faults": [
    {
      "properties": [
        "<string>"
      ],
      "description": "<string>"
    }
  ]
}

Body

application/json

data · any · required

Original document to correct.

options · any

Correction options (method, reason, stamps, etc.).

schema · boolean · default: false

When true, returns the available correction options schema instead of correcting.

Response

200

application/json

Corrected document, or correction options schema when schema is true