Get financial documents
posthttps://billing5.tranzila.com/api/documents_db/get_documents
This endpoint accepts json and returns json.
| Element Name | Data type | Mandatory | Note (default value in bold) |
|---|---|---|---|
| terminal_names | array of strings | Yes | Terminals for which documents are created |
| transaction_ids | array of integers | See note | Mandatory if all other fields empty |
| start_date | Date | See note | Format yyyy-mm-dd. Mandatory if all other fields empty |
| end_date | Date | See note | Format yyyy-mm-dd. Mandatory if all other fields empty |
| client_email | String | See note | Mandatory if all other fields empty |
JSON example: Input:
JSON
{
"terminal_names": ["terminalname1","terminalname2","terminalnamen"],
"client_email": "mymail@mydomain.com”,
"start_date": "2019-03-05",
"end_date": "2019-03-30"
}
Output:
JSON
{
"status_code": 0,
"status_msg": "Success",
"enquiry_key": "79b8ba07",
"documents": [
{
"id": "6252",
"number": "1001956",
"assignment_number": null,
"type": "IR",
"action": "1",
"total_charge_amount": 10,
"currency": "ILS",
"created_at": "2025-07-27 14:14:31",
"retrieval_key": "ZDA2ODJkNDZjNjY0NDkwZTEyMTJmODA5NWRkMDkxODAxNDgwOWY2MTdlY2IxMTY5MzcxMmRiMjYzYWExOGRkZjQyY2I5ZWRlODMxNjljNDlkNzk5NjdkMzAzOTMwODdmOTA4NjBhMjk3OGQyYmFkOThmYWU1ODNlNGI1YzNkMjE1STZMLzZYZ1Bwd2VNRXEvY2pTVm95THpsU3pZQ3d0UUpWUUhuSWNjU3FWbUgyKzlPYTh3b0JFc283YVBxakFXN0w2eXBJT1ppYUYwZEtwMHZjV3Qrdz09"
},
{
"id": "6253",
"number": "1001957",
"assignment_number": null,
"type": "IR",
"action": "3",
"total_charge_amount": 10,
"currency": "ILS",
"created_at": "2025-07-27 14:17:18",
"retrieval_key": "YjVmM2Y5MDgzYzNhNDAzZjAwM2JiMDUwNTQwYjgyZmE2NzcxNWY2Njc4MjFkNjM0OTA0MDJjOGIwMGEyMWI2ZmExYjlkNTc3OTVjYWRjZTg1MTg0ZTg2MjZmNWNlMmRmNThhNjE2NmZjYjZmMzJjOTZlZDIxZWY4ZDYxYjExNGQyKzRQT0hRUk9Mb2J2eFA2WSt0QlBMeHYyR3J4dnZKcEd5dnFXbE5FeFBuOXd5YklyUzdwdzVtak5tbktRWkpUajR5RWcyMlR6Q2lmVlkxZVlMVEJidz09"
},
{
"id": "6254",
"number": "1001958",
"assignment_number": null,
"type": "IR",
"action": "1",
"total_charge_amount": 9,
"currency": "ILS",
"created_at": "2025-07-27 14:20:24",
"retrieval_key": "N2M5ZGEyODZmYWVjNTU5M2FlMmI4M2VhODU2M2Y5YzllODE3MDQ1ZGM3YjM2YzUwZDM0ZmFiZjU5NDZlNzRmODNmZjVmM2MxNzY4NzViNmFmOWY4Y2YwYTA5ZjgxODQ3MzgwZDM4ZGE4ZTM5NWEyOTA3YjYyYzNhY2UzODgzMDdCRVZLMG9ZUHZvenpIZ0JlV3JndmU5Y3FGL3lTVXhRYlp6NFN4eVFKNTd2cjdZajVrV3FFc1BMUGlPSHRoa0kwS1hIQUk4TzF4SjhyNlZOSzBUbTcwZz09"
}
]
}
Responses
Returns a list of documents matching the search criteria.
The response includes:
status_code: 0 for successstatus_msg: Status messageenquiry_key: Enquiry key for this requestdocuments: Array of document objects with full details including assignment_number
Response body
response.json
JSON
1{
2 "status_code": 0,
3 "status_msg": "Success",
4 "enquiry_key": "79b8ba07",
5 "documents": [
6 {
7 "id": "6252",
8 "number": "1001956",
9 "assignment_number": null,
10 "type": "IR",
11 "action": "1",
12 "total_charge_amount": 10,
13 "currency": "ILS",
14 "created_at": "2025-07-27 14:14:31",
15 "retrieval_key": "ZDA2ODJkNDZjNjY0NDkwZTEyMTJmODA5NWRkMDkxODAxNDgwOWY2MTdlY2IxMTY5MzcxMmRiMjYzYWExOGRkZjQyY2I5ZWRlODMxNjljNDlkNzk5NjdkMzAzOTMwODdmOTA4NjBhMjk3OGQyYmFkOThmYWU1ODNlNGI1YzNkMjE1STZMLzZYZ1Bwd2VNRXEvY2pTVm95THpsU3pZQ3d0UUpWUUhuSWNjU3FWbUgyKzlPYTh3b0JFc283YVBxakFXN0w2eXBJT1ppYUYwZEtwMHZjV3Qrdz09"
16 }
17 ]
18}
19