Search documents

Time	Status	User Agent
Retrieving recent requests…

skip

string

Optional query variable , Starting record index. In this example, we begin from the first record Example: 0.

take

string

required

Optional query variable , Works in conjunction with "skip" and is required if "skip" is specified. In this case, takes 5 records Example: 5.

string

Search terms Example: john doe.

more_info

string

Search by more_info parameter Example: #test1.

number

string

Document number Example: ABC1234.

transaction_uuid

string

UUID of a PayPlus transaction Example: 83d7999d-76b6-41e1-bb4e-e6cdd4c4f784.

currency_code

string

Document currency Example: ILS.

paypal_transaction_id

string

Search by Paypal transaction ID Example: J345234LKGJ.

customer

string

Search by customer uuid Example: a5f514de-c8c8-262a-ac31-31d609f3550a.

fromDate

string

Date search. Ealiest date (YYYY-MM-DD) Example: 2022-01-01.

toDate

string

Date search. Latest date (YYYY-MM-DD) Example: 2022-01-01

dateType

string

enum

Date type of the parameters fromDate/Todatedoc_date - parameters fromDate/toDate will refer to the document date. This is defaultcreation_date - parameters fromDate/toDate will refer to the date on which the document was generated

Allowed:

brand_uuid

string

Show documents for a specific brand Example: a5f514de-c8c8-262a-ac31-31d609f3550a.

types

array of strings

Array of document types(string)inv_tax_receipt - Tax invoice/receiptinv_tax - Tax invoiceinv_receipt - Receiptinv_proforma - Proforma invoiceinv_refund - Refundcrt_delivery - Delivery/shipping certificatecrt_return - Return certificateorder_purchase - Order purchase certificatepurchase - Purchase certificatedc_quote - Quoteinv_don_receipt - Donation receiptinv_pay_request - Payment request

types

statuses

array of booleans

Search by document status(es)(string)CLOSEDOPENCANCELLED

statuses

minAmount

integer

Minimum total document amount Example: 100.

200200

400400