Skip to main content

Response Model

API responses are flat JSON objects with common fields plus route-specific fields.

Common fields:

  • status: success or error
  • code: integer (0 for success) — for errors, see §8 for the full list of possible values; may be absent (or null) for known business-rule errors that have no dedicated code, in which case rely on message
  • message: optional string (mainly for errors)

Error shape (dedicated code):

{
"status": "error",
"code": 9,
"message": "Document not found"
}

Error shape (no dedicated code — business-rule error, see §8 and §12.3):

{
"status": "error",
"message": "Deleting unclosed checks is disabled by settings"
}

Success shape example:

{
"status": "success",
"code": 0,
"documentID": 12345,
"fiscalID": "..."
}