---
updatedAt: 2025-05-28T09:46:16.000Z
agentTools:
  projectIndex: https://docs.payplus.co.il/llms.txt
---

# Search documents

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "PayPlus - API Documentation - Production",
    "version": "1.0"
  },
  "tags": [
    {
      "name": "Invoice+ - Documents"
    }
  ],
  "servers": [
    {
      "url": "https://restapi.payplus.co.il/api/v1.0/",
      "description": "Production"
    },
    {
      "url": "https://restapidev.payplus.co.il/api/v1.0/",
      "description": "Staging"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/books/docs/list": {
      "get": {
        "tags": [
          "Invoice+ - Documents"
        ],
        "summary": "Search documents",
        "description": "",
        "parameters": [
          {
            "name": "skip",
            "in": "query",
            "description": "Optional query variable , Starting record index. In this example, we begin from the first record Example: 0.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "take",
            "in": "query",
            "required": true,
            "description": "Optional query variable , Works in conjunction with \"skip\" and is required if \"skip\" is specified. In this case, takes 5 records Example: 5.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "search",
            "in": "query",
            "description": "Search terms Example: john doe.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "more_info",
            "in": "query",
            "description": "Search by more_info parameter Example: #test1.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "number",
            "in": "query",
            "description": "Document number Example: ABC1234.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "transaction_uuid",
            "in": "query",
            "description": "UUID of a PayPlus transaction Example: 83d7999d-76b6-41e1-bb4e-e6cdd4c4f784.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "currency_code",
            "in": "query",
            "description": "Document currency Example: ILS.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "paypal_transaction_id",
            "in": "query",
            "description": "Search by Paypal transaction ID Example: J345234LKGJ.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customer",
            "in": "query",
            "description": "Search by customer uuid Example: a5f514de-c8c8-262a-ac31-31d609f3550a.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fromDate",
            "in": "query",
            "description": "Date search. Ealiest date (YYYY-MM-DD) Example: 2022-01-01.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "toDate",
            "in": "query",
            "description": "Date search. Latest date (YYYY-MM-DD) Example: 2022-01-01",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "dateType",
            "in": "query",
            "description": "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",
            "schema": {
              "type": "string",
              "enum": [
                "doc_date",
                "creation_date"
              ]
            }
          },
          {
            "name": "brand_uuid",
            "in": "query",
            "description": "Show documents for a specific brand Example: a5f514de-c8c8-262a-ac31-31d609f3550a.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "types",
            "in": "query",
            "description": "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",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "statuses",
            "in": "query",
            "description": "Search by document status(es)(string)CLOSEDOPENCANCELLED",
            "schema": {
              "type": "array",
              "items": {
                "type": "boolean"
              }
            }
          },
          {
            "name": "minAmount",
            "in": "query",
            "description": "Minimum total document amount Example: 100.",
            "schema": {
              "type": "integer",
              "format": "int"
            }
          },
          {
            "name": "tags",
            "in": "query",
            "description": "Array of arbitrary strings used to catalogue/ tag documents",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "maxAmount",
            "in": "query",
            "description": "Maximum total document amount Example: 10000.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "paymentTypes",
            "in": "query",
            "description": "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",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "external_id",
            "in": "query",
            "description": "Search by transaction more_info field Example: rKov74nSGD0pezvuD0uPHgVz8.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "api-key",
            "in": "header",
            "description": "API Key",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "secret-key",
            "in": "header",
            "description": "Secret Key",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\"barcode\": \"472819632332439\",\n\"brand\": {\n\"name\": \"Company Name\",\n\"uuid\": \"67a8cc93-75ac-4832-8386-3eb5b24bf3d0\"\n},\n\"copyDocAddress\": \"https://restapi.payplus.co.il/getdoc/s/c/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf\",\n\"currency_code\": \"ILS\",\n\"customer\": {\n\"customer_name\": \"John Doe\",\n\"email\": \"johndoe@example.com\",\n\"phone\": \"123456789\",\n\"subject_code\": \"987654321\",\n\"uuid\": \"faa6280f-dba5-4889-9b15-de60e1527bdc\",\n\"vat_number\": \"1231231\"\n},\n\"customer_uuid\": \"faa6280f-dba5-4889-9b15-de60e1527bdc\",\n\"docUID\": \"1fa79282-61d1-4898-b7b9-afa67f46d34a\",\n\"doc_date\": \"2022-11-15\",\n\"doc_type\": \"inv_tax\",\n\"more_info\": null,\n\"number\": \"SCP/50042\",\n\"originalDocAddress\": \"https://restapi.payplus.co.il/getdoc/s/o/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf\",\n\"total_items_base_currency\": 150,\n\"validDocumentGenerated\": true\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "barcode": {
                      "type": "string",
                      "example": "472819632332439"
                    },
                    "brand": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "example": "Company Name"
                        },
                        "uuid": {
                          "type": "string",
                          "example": "67a8cc93-75ac-4832-8386-3eb5b24bf3d0"
                        }
                      }
                    },
                    "copyDocAddress": {
                      "type": "string",
                      "example": "https://restapi.payplus.co.il/getdoc/s/c/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf"
                    },
                    "currency_code": {
                      "type": "string",
                      "example": "ILS"
                    },
                    "customer": {
                      "type": "object",
                      "properties": {
                        "customer_name": {
                          "type": "string",
                          "example": "John Doe"
                        },
                        "email": {
                          "type": "string",
                          "example": "johndoe@example.com"
                        },
                        "phone": {
                          "type": "string",
                          "example": "123456789"
                        },
                        "subject_code": {
                          "type": "string",
                          "example": "987654321"
                        },
                        "uuid": {
                          "type": "string",
                          "example": "faa6280f-dba5-4889-9b15-de60e1527bdc"
                        },
                        "vat_number": {
                          "type": "string",
                          "example": "1231231"
                        }
                      }
                    },
                    "customer_uuid": {
                      "type": "string",
                      "example": "faa6280f-dba5-4889-9b15-de60e1527bdc"
                    },
                    "docUID": {
                      "type": "string",
                      "example": "1fa79282-61d1-4898-b7b9-afa67f46d34a"
                    },
                    "doc_date": {
                      "type": "string",
                      "example": "2022-11-15"
                    },
                    "doc_type": {
                      "type": "string",
                      "example": "inv_tax"
                    },
                    "more_info": {},
                    "number": {
                      "type": "string",
                      "example": "SCP/50042"
                    },
                    "originalDocAddress": {
                      "type": "string",
                      "example": "https://restapi.payplus.co.il/getdoc/s/o/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf"
                    },
                    "total_items_base_currency": {
                      "type": "integer",
                      "example": 150,
                      "default": 0
                    },
                    "validDocumentGenerated": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```