---
title: "DocumentsBySearchCriteria (Yuki)"
description: "Documents by Search Criteria"
language: en
source_language: en
translation_state: complete
canonical: https://documentation.invantive.eu/en/datamodels/yuki/Yuki.Archive.DocumentsBySearchCriteria
original: https://documentation.invantive.eu/en/datamodels/yuki/Yuki.Archive.DocumentsBySearchCriteria
updated: 2026-11-01T16:27:26Z
license: https://documentation.invantive.eu/en/
---

# DocumentsBySearchCriteria: Yuki Documents by Search Criteria

`read only` `XML`

- Catalog: `Yuki`
- Schema: `Archive`
- Label: Documents by Search Criteria

Can only retrieve data.

## API Source

- XML service: `https://api.yukiworks.nl/ws/Archive.asmx`
- XML topic: `SearchDocuments`
- XML path: `/tns:SearchDocumentsResult/Documents/Document`

## Performance Characteristics

| Characteristic | Value |
|---|---:|
| Average access latency (ms) | 31 |

The result can be cached on the client.

## Parameters

| Name | Data Type | Required | Default | Documentation |
|---|---|:---:|---|---|
| `documentID` | `` | [ ] |  |  |
| `endDate` | `` | [ ] |  |  |
| `folderID` | `` | [x] |  | Yuki answers an internal error without the folder of the documents to search. |
| `searchOption` | `` | [ ] |  | All or Creator or Contact or Subject or Tag or Type |
| `searchText` | `` | [ ] |  |  |
| `sortOrder` | `` | [ ] |  | CreatedDesc or CreatedAsc or ModifiedDesc or ModifiedAsc or DocumentDateDesc or DocumentDateAsc or ContactNameAsc or ContactNameDesc |
| `startDate` | `` | [ ] |  |  |
| `tabID` | `` | [x] |  | Yuki answers an internal error without the tab of the documents to search. |

## Table Columns

The columns of the table `DocumentsBySearchCriteria` are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|:---:|---|---|
| `AMOUNT` | `decimal` | Amount | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/Amount` |  |
| `CONTACTNAME` | `varchar2` | itgen_yuki_contactname | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/ContactName` |  |
| `CONTENTTYPE` | `varchar2` | itgen_yuki_contenttype | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/ContentType` |  |
| `CREATED` | `datetime` | itgen_yuki_created | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/Created` |  |
| `CREATOR` | `varchar2` | itgen_yuki_creator | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/Creator` |  |
| `DOCUMENTDATE` | `datetime` | itgen_yuki_documentdate | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/DocumentDate` |  |
| `DOMAINID` | `varchar2(36)` | Domain ID | [ ] |  |  |
| `DOMAINNAME` | `varchar2(240)` | Domain Name | [ ] |  |  |
| `FILENAME` | `varchar2` | File Name | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/FileName` |  |
| `FILESIZE` | `int32` | itgen_yuki_filesize | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/FileSize` |  |
| `FOLDERDESCRIPTION` | `varchar2` | itgen_yuki_folderdescription | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/Folder` |  |
| `FOLDERID` | `varchar2` | itgen_yuki_folderid | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/Folder/ID` |  |
| `ID` | `varchar2` | ID | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/ID` |  |
| `MODIFIED` | `datetime` | itgen_yuki_modified | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/Modified` |  |
| `MODIFIER` | `varchar2` | itgen_yuki_modifier | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/Modifier` |  |
| `PAYMENTID` | `varchar2` | itgen_yuki_paymentid | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/PaymentID` |  |
| `PAYMENTREFERENCE` | `varchar2` | itgen_yuki_paymentreference | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/PaymentReference` |  |
| `SUBJECT` | `varchar2` | itgen_yuki_subject | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/Subject` |  |
| `TABDESCRIPTION` | `varchar2` | itgen_yuki_tabdescription | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/Tab` |  |
| `TABID` | `varchar2` | itgen_yuki_tabid | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/Tab/ID` |  |
| `TYPE` | `varchar2` | Type | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/Type` |  |
| `TYPEDESCRIPTION` | `varchar2` | itgen_yuki_typedescription | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/TypeDescription` |  |
| `VATAMOUNT` | `decimal` | itgen_yuki_vatamount | [ ] | `/soap11:Envelope/soap11:Body/tns:SearchDocumentsResponse/tns:SearchDocumentsResult/Documents/Document/VATAmount` |  |



## Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver:

- [Yuki](/en/release-notes/drivers?driver=yuki)

### Changes of This Table, 26.0 to 27.0

<div class="rn-item" id="YKI-27.0-D001">

##### Parameter folderID of Yuki.Archive.DocumentsBySearchCriteria: presence required changes

Presence required changes from false to true. Without these parameters Yuki already answered with an internal error, so no working statement is affected.

<div class="rn-chips">

- `false` &rarr; `true`
- importance 3

</div>

</div>

<div class="rn-item" id="YKI-27.0-D002">

##### Parameter tabID of Yuki.Archive.DocumentsBySearchCriteria: presence required changes

Presence required changes from false to true. Without these parameters Yuki already answered with an internal error, so no working statement is affected.

<div class="rn-chips">

- `false` &rarr; `true`
- importance 3

</div>

</div>

<div class="rn-item" id="YKI-27.0-D023">

##### Yuki.Archive.DocumentsBySearchCriteria: table parameters changes

Table parameters of Yuki.Archive.DocumentsBySearchCriteria changes from documentID, searchOption, searchText, folderID, tabID, startDate, endDate to documentID, searchOption, searchText, folderID, tabID, startDate, endDate, sortOrder.

<div class="rn-chips">

- `documentID, searchOption, searchText, folderID, tabID, startDate, endDate` &rarr; `documentID, searchOption, searchText, folderID, tabID, startDate, endDate, sortOrder`
- importance 3

</div>

</div>

<div class="rn-item" id="YKI-27.0-D144">

##### Parameter sortOrder is added to Yuki.Archive.DocumentsBySearchCriteria

Optional.

<div class="rn-chips">

- importance 2

</div>

</div>

<a id="YKI-27.0-D050"></a><a id="YKI-27.0-D051"></a><a id="YKI-27.0-D052"></a>

- `+` `PAYMENTID` (`varchar2`)
- `+` `PAYMENTREFERENCE` (`varchar2`)
- `+` `VATAMOUNT` (`decimal`)

[All changes of the driver, 26.0 to 27.0](/en/release-notes/drivers?driver=yuki&step=26.0-to-27.0#yuki-26.0-to-27.0)

