Correct GOBL envelope

Correct or determine the correction options for a GOBL Envelope (not Object!)

POST /silo/v1/gobl/correct

cURL

cURL

curl --request POST \
  --url https://api.invopop.com/silo/v1/gobl/correct \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {},
  "options": {},
  "show_options": true
}
'

200

{
  "data": {}
}

Use this endpoint to help determine the options for correcting GOBL documents and then perform the correction itself.

This is useful when you need to issue credit notes or corrective versions of a previously issued invoice and need clarity on the local options.

All requests to the endpoint require a GOBL Envelope, and cannot be used with a GOBL Invoice or other GOBL object. This is because some tax regimes require specific details from the previous document’s headers, like a special identification code.

Use the show_options flag to return a JSON Schema of the options that can be used with the provided document.

Once the options are clear, send in a new request with the options data to get an example corrected GOBL Envelope. The same options data can be used with the silo create entry endpoint and the correct property.

Authorizations

Authorization · string · header · required

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

Body

application/json

data · Data · object

GOBL Envelope or Object to calculate and validate.

options · Options · object

JSON object containing the GOBL correction option data.

show_options · boolean

When true, the options schema for correction are provided in the response.

Response

200 - application/json

OK

data · Data · object

GOBL Envelope or Object response to a build request.