Skip to content

Commit 228e249

Browse files
committed
Add details on params to get_documents documentation
1 parent e81a173 commit 228e249

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

veryfi/client.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -138,13 +138,13 @@ def get_documents(
138138
):
139139
"""
140140
Get list of documents
141-
:param query: Search term to search for a specific document by its content
141+
:param query: Search term to search for a specific document by its content. These fields will be searched: external_id, category, vendor.name, notes, invoice_number, total and ocr_text.
142142
:param external_id: Search for documents that match your custom identifier
143143
:param tag: Search for documents with the specified tag
144-
:param created__gt: Search for documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS
145-
:param created__gte: Search for documents with a created date greater than or equal to this one. Format YYYY-MM-DD+HH:MM:SS
146-
:param created__lt: Search for documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS
147-
:param created__lte: Search for documents with a created date less than or equal to this one. Format YYYY-MM-DD+HH:MM:SS
144+
:param created__gt: Search for documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created__gt and created__gte in a single request.
145+
:param created__gte: Search for documents with a created date greater than or equal to this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created__gt and created__gte in a single request.
146+
:param created__lt: Search for documents with a created date greater than this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created__lt and created__lte in a single request.
147+
:param created__lte: Search for documents with a created date less than or equal to this one. Format YYYY-MM-DD+HH:MM:SS. Don't send both created__lt and created__lte in a single request.
148148
:param kwargs: Additional request parameters
149149
:return: List of previously processed documents
150150
"""

0 commit comments

Comments
 (0)