Access Client PDF Statements

The client API provides two endpoints for accessing statements that were generated for the authenticated client.
First call Client_X_Statements_List to obtain the available statements, then call Download_X_Statement with the selected statement's exact creation timestamp.
The authenticated client is determined by ClientNumber and API_Password; it is not supplied as a query filter.

List available statements

The Client_X_Statements_List endpoint returns the statements belonging to the authenticated client only.
The returned array is ordered by CreatedOn, newest first.
The optional Where array can narrow the result. When it is omitted, all available statements for the client are returned.

The list is also retained by the server for the current API session. Call this endpoint before Download_X_Statement and use the same authenticated session for both requests.

Function Input

{
  "ClientNumber": 500608,
  "API_Password": "8Lba7u5smABC",
  "Where": [
    {
      "FldName": "CreatedOn",
      "InRange": {
        "Min": "2026-01-01",
        "Max": "2026-06-30",
        "DateTimeLogic": "Whole Days Anyway"
      }
    }
  ]
}
// Omit the Where array to retrieve the full statement list.

Field	Description
ClientNumber	The unique identifier of the client whose statements are requested. (Integer)
API_Password	The client API password used to authenticate the request. (String)
Where	Optional array of filtering conditions. The example above limits results by CreatedOn. Read about our query syntax in this page.

Function Output

Here is an example of a successful response:

{
  "ResponseCode":0,
  "ResponseMsgEng":"Success",
  "X_Statements":[
    {
      "CreatedOn":"2022-11-23 10:24:11.765",
      "Title":"חשבונית מס: 1002",
      "Status":"בוצע בהצלחה",
      "FileSizeMb":0.11,
      "Language":"Hebrew",
      "PreProcessFile":"חתימה דיגיטלית",
      "PreProcessConfirmationUtc":"2022-11-23 10:24:12.127",
      "TargetEmailAddress":"yaniv@walla.co.il\r\neinat@walla.co.il",
      "MessageBodyTemplate":"",
      "SendFromMailbox":"",
      "SentConfirmationUtc":"2022-11-23 10:24:13.252",
      "FirstDownloadUtc":"",
      "LastDownloadUtc":"",
      "Accessibility":0,
      "Attachment":1,
      "DocId":""
    },
    {
      "CreatedOn":"2022-11-23 09:41:06.513",
      "Title":"חוזה הלוואה: 4",
      "Status":"בוצע בהצלחה",
      "FileSizeMb":0.59,
      "Language":"Hebrew",
      "PreProcessFile":"הצפנה (עם סיסמה)",
      "PreProcessConfirmationUtc":"2022-11-23 09:41:07.692",
      "TargetEmailAddress":"yaniv@walla.co.il\r\neinat@walla.co.il",
      "MessageBodyTemplate":"",
      "SendFromMailbox":"",
      "SentConfirmationUtc":"2022-11-23 09:41:45.255",
      "FirstDownloadUtc":"",
      "LastDownloadUtc":"",
      "Accessibility":0,
      "Attachment":1,
      "DocId":""
    },
    {
      "CreatedOn":"2022-10-19 08:26:10.991",
      "Title":"הצעה למתן הלוואה: 5",
      "Status":"תקלה \/ נדחה",
      "FileSizeMb":0.48,
      "Language":"Hebrew",
      "PreProcessFile":"ללא",
      "PreProcessConfirmationUtc":"",
      "TargetEmailAddress":"yaniv@walla.co.il",
      "MessageBodyTemplate":"",
      "SendFromMailbox":"",
      "SentConfirmationUtc":"",
      "FirstDownloadUtc":"",
      "LastDownloadUtc":"",
      "Accessibility":0,
      "Attachment":1,
      "DocId":""
    }
  ]
}

Field	Description
ResponseCode	Integer execution result. A value of 0 indicates success.
ResponseMsgEng	English message describing the execution result.
X_Statements An array of statement metadata. It can be empty when the authenticated client has no matching statements.
X_Statements.CreatedOn	The statement creation timestamp. This is the unique value required by Download_X_Statement; copy it exactly from the list response. (String)
X_Statements.Title	The statement title in the client's language. It is also used as the downloaded file name. (String)
X_Statements.Status	The statement processing status: No Task, Waiting in queue, Error / Rejected, or OK done. (String)
X_Statements.FileSizeMb	The size of the stored statement file in megabytes. (Number)
X_Statements.Language	The language selected when the statement was produced. (String)
X_Statements.PreProcessFile X_Statements.PreProcessConfirmationUtc	The optional protection applied to the file and the UTC timestamp at which that processing was completed. Possible protection values are None, Digital Sign, Encode (with Password), and Encode & Block Printing.
X_Statements.TargetEmailAddress X_Statements.MessageBodyTemplate X_Statements.SendFromMailbox	Mail-delivery metadata: recipient address or addresses, message-body template, and the sending mailbox. (String)
X_Statements.SentConfirmationUtc	The UTC timestamp confirming that the statement was sent by email. An empty value means no confirmation is available.
X_Statements.FirstDownloadUtc X_Statements.LastDownloadUtc	The first and most recent UTC timestamps recorded for a download. Empty values mean that no timestamp is recorded.
X_Statements.Accessibility	Indicates whether accessibility reading assistance (html version) is available for this document. (Boolean)
X_Statements.Attachment	Indicates whether the statement was attached to the email sent to the client. (Boolean)
X_Statements.DocId	An optional document identifier used to prevent duplicate statements for the same client. (String)

Download a statement

The Download_X_Statement endpoint downloads the binary statement file selected from the current session's Client_X_Statements_List response.
The request must use the same authenticated API session and must provide the exact CreatedOn value returned by the list endpoint. Do not alter its date, time, or precision.

On success, this endpoint returns the file stream rather than a JSON response. The response file name is built from the statement Title and its stored file extension.

Function Input

{
  "ClientNumber": 500608,
  "API_Password": "8Lba7u5smABC",
  "CreatedOn":"2022-10-19 08:26:10.991"
}

Field	Description
ClientNumber API_Password	Client API credentials. They must identify the same client session used for Client_X_Statements_List.
CreatedOn	The exact creation timestamp of one statement from X_Statements.CreatedOn. This field is required. (String, YYYY-MM-DD HH:MM:SS.ZZZ)

Function Output

On success, the HTTP response is the requested media file. For example:

HTTP/1.1 200 OK
Connection: close
Accept-Ranges: bytes
Content-Type: application/pdf
Content-Length: 504723
Cache-Control: no-store, no-cache, must-revalidate
Date: Sat, 01 Aug 2026 22:00:57 GMT
Content-Disposition:attachment; filename="הצעה למתן הלוואה: 5.pdf"
X-Frame-Options: SAMEORIGIN
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Access-Control-Allow-Origin: *

%PDF-1.7
1 0 obj
<>
endobj
4 0 obj
<>
stream
x���Ohm߂'�3p�D��)8l� ���8P �I~��(� Z���r�ƒ   G5� �� )lZ s E�#�t9 ����IQ�
L �� D N2S �q%;Ywe��^���9I> �%7g�Y{��O�]߳��l

If CreatedOn does not match an item retained from the preceding list response, the endpoint returns a JSON error with a non-zero ResponseCode instead of a file.