v1

latestOpenAPI 3.1.02026-07-241210356.3 KB

Invoice+ - Documents

Search documents

get/books/docs/list

Query parameters

skipstring

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

takestring required

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

searchstring

Search terms Example: john doe.

more_infostring

Search by more_info parameter Example: #test1.

numberstring

Document number Example: ABC1234.

transaction_uuidstring

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

currency_codestring

Document currency Example: ILS.

paypal_transaction_idstring

Search by Paypal transaction ID Example: J345234LKGJ.

customerstring

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

fromDatestring

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

toDatestring

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

dateType'doc_date' | 'creation_date'

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

brand_uuidstring

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

typesstring[]

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

statusesboolean[]

Search by document status(es)(string)CLOSEDOPENCANCELLED

minAmountinteger

Minimum total document amount Example: 100.

tagsstring[]

Array of arbitrary strings used to catalogue/ tag documents

maxAmountstring

Maximum total document amount Example: 10000.

paymentTypesstring[]

Filter by payment type(s)(string)credit-cardcashpaypalbank-transferpayment-checkotherwithholding-taxpayment-app-bitpayment-app-maxpayment-app-apple-paypayment-app-google-paypayment-app-multipasspayment-app-pay-box

external_idstring

Search by transaction more_info field Example: rKov74nSGD0pezvuD0uPHgVz8.

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Response

200

barcodestring

copyDocAddressstring

currency_codestring

customer_uuidstring

docUIDstring

doc_datestring

doc_typestring

{"stackTrail":"paths:/books/docs/list:get:responses:200:content:application/json:schema:properties:more_info","oasType":"schema","type":"unknown"}

numberstring

originalDocAddressstring

total_items_base_currencyinteger

validDocumentGeneratedboolean

Example response

{
  "barcode": "472819632332439",
  "brand": {
    "name": "Company Name",
    "uuid": "67a8cc93-75ac-4832-8386-3eb5b24bf3d0"
  },
  "copyDocAddress": "https://restapi.payplus.co.il/getdoc/s/c/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf",
  "currency_code": "ILS",
  "customer": {
    "customer_name": "John Doe",
    "email": "johndoe@example.com",
    "phone": "123456789",
    "subject_code": "987654321",
    "uuid": "faa6280f-dba5-4889-9b15-de60e1527bdc",
    "vat_number": "1231231"
  },
  "customer_uuid": "faa6280f-dba5-4889-9b15-de60e1527bdc",
  "docUID": "1fa79282-61d1-4898-b7b9-afa67f46d34a",
  "doc_date": "2022-11-15",
  "doc_type": "inv_tax",
  "number": "SCP/50042",
  "originalDocAddress": "https://restapi.payplus.co.il/getdoc/s/o/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf",
  "total_items_base_currency": 150,
  "validDocumentGenerated": true
}