Get financial document

posthttps://billing5.tranzila.com/api/documents_db/get_document

This endpoint will generate a PDF upon success and return JSON in case of an error.

Element Name	Data type	Mandatory	Note (default value in bold)
terminal_name	String	Yes	Terminal in which a document was created
document_id	integer	Yes
response_language	String	No	eng

JSON Example

JSON

{
  "terminal_name": "terminalname",
  “document_id”: “11823”
}

Request

Body

application/json

terminal_namestringrequired

Terminal in which the document was created

Example:terminalname

document_idstringrequired

Document ID

Example:11823

response_languagestring

Response language: 'eng' for English, 'heb' for Hebrew

Allowed values:engheb

Example:eng

Responses

Success: Returns PDF file

When successful, this endpoint returns the PDF document file directly. The response Content-Type will be application/pdf.

Error: Returns JSON

When an error occurs, returns JSON with error details:

status_code: Error code (see error codes section)
status_msg: Error message

Common errors:

10600: Unknown document id
10601: Document ID not found in database
10602: No PDF file found for document

Response body

response.json

JSON

1{
2  "status_code": 10600,
3  "status_msg": "Unknown document id"
4}
5

Body

1{
2  "terminal_name": "terminalname",
3  "document_id": "11823"
4}
5

Request Sample

curl --request POST \
  --url https://billing5.tranzila.com/api/documents_db/get_document \
  --header 'Content-Type: application/json' \
  --data '{  "terminal_name": "terminalname",  "document_id": "11823"}'

Response Example: Error 10600 - Document not found

1{
2  "status_code": 10600,
3  "status_msg": "Unknown document id"
4}
5