# DocuWare

> Store, find, file and download documents in DocuWare with their index values, stamp them, and act on DocuWare workflow tasks.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/docuware

## Actions

### Add file to document

Add a file to a document that's already stored, such as an attachment or a file for an index-only record.

**Inputs**

- File cabinet or document tray (`file_cabinet_id`, text, required): Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.
- Document ID (`document_id`, text, required): The document's id, a whole number, from a search, a list, a trigger or an earlier step.
- File (`file`, text, required): The file: upload one, pick a file from an earlier step, or paste a public https link to one.

**Outputs**

- `document` (object): The document

**Example output**

```json
{
  "document": {
    "content_type": "application/pdf",
    "field_list": [
      {
        "is_null": false,
        "label": "Company",
        "name": "COMPANY",
        "read_only": false,
        "system_field": false,
        "type": "String",
        "value": "Example Supply Co."
      },
      {
        "is_null": false,
        "label": "Document date",
        "name": "DOCUMENT_DATE",
        "read_only": false,
        "system_field": false,
        "type": "Date",
        "value": "2026-10-20"
      },
      {
        "is_null": false,
        "label": "Stored on",
        "name": "DWSTOREDATETIME",
        "read_only": true,
        "system_field": true,
        "type": "DateTime",
        "value": "2026-10-28T14:05:00Z"
      }
    ],
    "fields": {
      "COMPANY": "Example Supply Co.",
      "DOCUMENT_DATE": "2026-10-20",
      "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
    },
    "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
    "file_size": 48213,
    "id": 1234,
    "is_checked_out": false,
    "is_data_record": false,
    "modified_at": "2026-10-28T14:05:00Z",
    "section_count": 1,
    "sections": [
      {
        "content_type": "application/pdf",
        "file_size": 48213,
        "id": "1234-5678",
        "original_file_name": "invoice-4711.pdf",
        "page_count": 2
      }
    ],
    "stored_at": "2026-10-28T14:05:00Z",
    "title": "Invoice 4711",
    "total_pages": 2,
    "version_status": "Disable"
  }
}
```

### Confirm task

Take a decision on a workflow task, such as Approve, filling in what the decision asks for. The workflow moves on in DocuWare.

**Inputs**

- DocuWare workflow (`docuware_workflow_id`, text, required): The DocuWare workflow. Pick one, or give its id from an earlier step.
- Instance ID (`instance_id`, text, required): The task's 'instance_id', from 'List tasks' or the trigger.
- Task ID (`task_id`, text, required): The task's 'id', from 'List tasks' or the trigger.
- Decision (`decision`, text, required): The decision as it appears on the task, such as Approve. 'Get task' lists them.
- Decision fields (`form_values`, object): What the decision asks for, by its label, such as {"Comment": "Checked against the order"}.

**Outputs**

- `confirmed` (true/false): Always true once confirmed
- `decision` (text): The decision taken
- `decision_id` (number): The decision's id
- `docuware_workflow_id` (text): Its workflow
- `instance_id` (text): Its workflow instance
- `task_id` (text): The task confirmed

**Example output**

```json
{
  "confirmed": true,
  "decision": "Approve",
  "decision_id": 1,
  "docuware_workflow_id": "29341189-7564-4194-ba2c-33963f41891f",
  "instance_id": "b13d1794-b4b7-5e99-91d9-0bcaa13036f3",
  "task_id": "8e0c1a52-3d4b-4bb4-9f5e-2c6d1e7a9b10"
}
```

### Delete document

Delete a document. DocuWare keeps it in its trash bin for a while, if the organization has one.

**Inputs**

- File cabinet or document tray (`file_cabinet_id`, text, required): Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.
- Document ID (`document_id`, text, required): The document's id, a whole number, from a search, a list, a trigger or an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `document_id` (number): The document deleted
- `file_cabinet_id` (text): The file cabinet it was in

**Example output**

```json
{
  "deleted": true,
  "document_id": 1234,
  "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709"
}
```

### Download document

Download a document's file, as stored or as a PDF, for a later step to attach or send.

**Inputs**

- File cabinet or document tray (`file_cabinet_id`, text, required): Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.
- Document ID (`document_id`, text, required): The document's id, a whole number, from a search, a list, a trigger or an earlier step.
- Format (`file_format`, text): As stored (the default; several files come as a ZIP), as one PDF, or always as a ZIP. One of: `Auto` (As stored (default)), `PDF`, `Zip` (ZIP of the original files).
- Include stamps and notes (`keep_annotations`, true/false): Burn the document's stamps and annotations into the file.

**Outputs**

- `content_type` (text): The file's type, such as application/pdf
- `document_id` (number): The DocuWare document downloaded
- `document_ref` (text): The downloaded file, for later steps
- `file_cabinet_id` (text): The file cabinet it is in
- `filename` (text): The file's name
- `size_bytes` (number): The file's size in bytes
- `url` (text): Where to open the downloaded file

**Example output**

```json
{
  "content_type": "application/pdf",
  "document_id": 1234,
  "document_ref": "doc_0123456789abcdef0123456789abcdef",
  "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
  "filename": "invoice-4711.pdf",
  "size_bytes": 48213,
  "url": "/actions/core/serve-document/doc_0123456789abcdef0123456789abcdef"
}
```

### Get document

Get one document's index values, files and details, such as when it was stored and changed.

**Inputs**

- File cabinet or document tray (`file_cabinet_id`, text, required): Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.
- Document ID (`document_id`, text, required): The document's id, a whole number, from a search, a list, a trigger or an earlier step.

**Outputs**

- `document` (object): The document

**Example output**

```json
{
  "document": {
    "content_type": "application/pdf",
    "field_list": [
      {
        "is_null": false,
        "label": "Company",
        "name": "COMPANY",
        "read_only": false,
        "system_field": false,
        "type": "String",
        "value": "Example Supply Co."
      },
      {
        "is_null": false,
        "label": "Document date",
        "name": "DOCUMENT_DATE",
        "read_only": false,
        "system_field": false,
        "type": "Date",
        "value": "2026-10-20"
      },
      {
        "is_null": false,
        "label": "Stored on",
        "name": "DWSTOREDATETIME",
        "read_only": true,
        "system_field": true,
        "type": "DateTime",
        "value": "2026-10-28T14:05:00Z"
      }
    ],
    "fields": {
      "COMPANY": "Example Supply Co.",
      "DOCUMENT_DATE": "2026-10-20",
      "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
    },
    "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
    "file_size": 48213,
    "id": 1234,
    "is_checked_out": false,
    "is_data_record": false,
    "modified_at": "2026-10-28T14:05:00Z",
    "section_count": 1,
    "sections": [
      {
        "content_type": "application/pdf",
        "file_size": 48213,
        "id": "1234-5678",
        "original_file_name": "invoice-4711.pdf",
        "page_count": 2
      }
    ],
    "stored_at": "2026-10-28T14:05:00Z",
    "title": "Invoice 4711",
    "total_pages": 2,
    "version_status": "Disable"
  }
}
```

### Get document's workflow history

Get the DocuWare workflows a document has been through, step by step: who decided what, and when.

**Inputs**

- File cabinet (`file_cabinet_id`, text, required): The file cabinet. Pick one, or give its id from an earlier step.
- Document ID (`document_id`, text, required): The document's id, a whole number, from a search, a list, a trigger or an earlier step.

**Outputs**

- `count` (number): How many workflow runs
- `document_id` (number): The document
- `instances` (list): Each workflow run, with its steps

**Example output**

```json
{
  "count": 1,
  "document_id": 1234,
  "instances": [
    {
      "instance_id": "b13d1794-b4b7-5e99-91d9-0bcaa13036f3",
      "name": "Invoice approval",
      "started_at": "2026-10-28T14:06:00Z",
      "steps": [
        {
          "activity": "Approve invoice",
          "activity_type": "GeneralTask",
          "date": "2026-10-28T15:30:00Z",
          "decision": "Approve",
          "step_type": "Decision",
          "user": "Jo Bloggs"
        }
      ],
      "version": 3,
      "workflow_id": "29341189-7564-4194-ba2c-33963f41891f"
    }
  ]
}
```

### Get file cabinet

Get a file cabinet or document tray with its index fields: each field's database name, label and type.

**Inputs**

- File cabinet or document tray (`file_cabinet_id`, text, required): Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.

**Outputs**

- `field_count` (number): How many index fields
- `fields` (list): Its index fields
- `file_cabinet` (object): The file cabinet

**Example output**

```json
{
  "field_count": 2,
  "fields": [
    {
      "label": "Company",
      "length": 100,
      "name": "COMPANY",
      "precision": 0,
      "system_field": false,
      "type": "Text",
      "used_as_document_name": true
    },
    {
      "label": "Document date",
      "length": 0,
      "name": "DOCUMENT_DATE",
      "precision": 0,
      "system_field": false,
      "type": "Date",
      "used_as_document_name": false
    }
  ],
  "file_cabinet": {
    "color": "Blue",
    "has_full_text_search": true,
    "id": "0242b887-0261-473d-aa59-96eb5cd5f709",
    "is_default": true,
    "is_document_tray": false,
    "name": "Records",
    "usable": true
  }
}
```

### Get organization

Get the DocuWare organization the connection signs in to, with its name and id.

**Inputs**: None.

**Outputs**

- `address` (text): The DocuWare address signed in to
- `organization` (object): The organization
- `organizations` (list): Every organization the user belongs to

**Example output**

```json
{
  "address": "https://cityofexample.docuware.cloud",
  "organization": {
    "guid": "7a1d0c3e-5b2f-4e8a-9c6d-1f2e3a4b5c6d",
    "id": "1",
    "name": "City of Example"
  },
  "organizations": [
    {
      "guid": "7a1d0c3e-5b2f-4e8a-9c6d-1f2e3a4b5c6d",
      "id": "1",
      "name": "City of Example"
    }
  ]
}
```

### Get task

Get one workflow task with the decisions that can be taken and what each asks for.

**Inputs**

- DocuWare workflow (`docuware_workflow_id`, text, required): The DocuWare workflow. Pick one, or give its id from an earlier step.
- Instance ID (`instance_id`, text, required): The task's 'instance_id', from 'List tasks' or the trigger.
- Task ID (`task_id`, text, required): The task's 'id', from 'List tasks' or the trigger.

**Outputs**

- `task` (object): The task

**Example output**

```json
{
  "task": {
    "activity": "Approve invoice",
    "activity_type": "GeneralTask",
    "columns": {
      "COMPANY": "Example Supply Co.",
      "ReceivedOn": "2026-10-28T14:06:00Z"
    },
    "decisions": [
      {
        "description": "Approve the invoice",
        "form_fields": [
          {
            "description": "Why",
            "id": 3,
            "label": "Comment",
            "read_only": false,
            "required": false,
            "type": "Text"
          }
        ],
        "id": 1,
        "label": "Approve"
      },
      {
        "description": "Send it back",
        "form_fields": [],
        "id": 2,
        "label": "Reject"
      }
    ],
    "default_decision_id": 1,
    "document_id": 1234,
    "id": "8e0c1a52-3d4b-4bb4-9f5e-2c6d1e7a9b10",
    "instance_id": "b13d1794-b4b7-5e99-91d9-0bcaa13036f3",
    "is_read": false,
    "workflow_id": "29341189-7564-4194-ba2c-33963f41891f"
  }
}
```

### List dialogs

List a file cabinet's dialogs (search, store, result list and so on) that the DocuWare user may use.

**Inputs**

- File cabinet (`file_cabinet_id`, text, required): The file cabinet. Pick one, or give its id from an earlier step.
- Type (`dialog_type`, text): Only dialogs of this type. Leave empty for all. One of: `Search` (Search dialogs), `Store` (Store dialogs), `ResultList` (Result lists), `InfoDialog` (Info dialogs), `TaskList` (Task lists).

**Outputs**

- `count` (number): How many
- `dialogs` (list): The dialogs

**Example output**

```json
{
  "count": 1,
  "dialogs": [
    {
      "assigned_dialog_id": "6e1c2b3d-4f5a-4b6c-9d7e-8f9a0b1c2d3e",
      "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
      "id": "5d0b1a2c-3e4f-4a5b-8c6d-7e8f9a0b1c2d",
      "is_default": true,
      "name": "Search invoices",
      "type": "Search"
    }
  ]
}
```

### List documents

List the documents in a file cabinet or document tray, newest first, with their index values. Returns one page; pass 'next_start' as 'Skip' for more.

**Inputs**

- File cabinet or document tray (`file_cabinet_id`, text, required): Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.
- Order (`order`, text): Newest stored first (the default), oldest first, or most recently changed first. One of: `newest` (Newest stored first (default)), `oldest` (Oldest stored first), `modified` (Most recently changed first).
- How many (`count`, number): How many to return, 1 to 500. Defaults to 50. From 1 to 500.
- Skip (`start`, number): How many to skip, for the next page: the 'next_start' of an earlier step. Defaults to 0. At least 0.

**Outputs**

- `count` (number): How many documents this page holds
- `documents` (list): The documents
- `has_more` (true/false): True when there are more to read
- `next_start` (number): The 'Skip' value for the next page
- `total` (number): How many documents match in all

**Example output**

```json
{
  "count": 1,
  "documents": [
    {
      "content_type": "application/pdf",
      "field_list": [
        {
          "is_null": false,
          "label": "Company",
          "name": "COMPANY",
          "read_only": false,
          "system_field": false,
          "type": "String",
          "value": "Example Supply Co."
        },
        {
          "is_null": false,
          "label": "Document date",
          "name": "DOCUMENT_DATE",
          "read_only": false,
          "system_field": false,
          "type": "Date",
          "value": "2026-10-20"
        },
        {
          "is_null": false,
          "label": "Stored on",
          "name": "DWSTOREDATETIME",
          "read_only": true,
          "system_field": true,
          "type": "DateTime",
          "value": "2026-10-28T14:05:00Z"
        }
      ],
      "fields": {
        "COMPANY": "Example Supply Co.",
        "DOCUMENT_DATE": "2026-10-20",
        "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
      },
      "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
      "file_size": 48213,
      "id": 1234,
      "is_checked_out": false,
      "is_data_record": false,
      "modified_at": "2026-10-28T14:05:00Z",
      "section_count": 1,
      "sections": [
        {
          "content_type": "application/pdf",
          "file_size": 48213,
          "id": "1234-5678",
          "original_file_name": "invoice-4711.pdf",
          "page_count": 2
        }
      ],
      "stored_at": "2026-10-28T14:05:00Z",
      "title": "Invoice 4711",
      "total_pages": 2,
      "version_status": "Disable"
    }
  ],
  "has_more": false,
  "next_start": 1,
  "total": 1
}
```

### List file cabinets

List the file cabinets and document trays the DocuWare user can see, with their ids.

**Inputs**

- Which (`cabinet_kind`, text): File cabinets, document trays, or both (the default). One of: `all` (File cabinets and document trays (default)), `cabinets` (File cabinets only), `trays` (Document trays only).

**Outputs**

- `count` (number): How many
- `file_cabinets` (list): The file cabinets and document trays

**Example output**

```json
{
  "count": 2,
  "file_cabinets": [
    {
      "color": "Blue",
      "has_full_text_search": true,
      "id": "0242b887-0261-473d-aa59-96eb5cd5f709",
      "is_default": true,
      "is_document_tray": false,
      "name": "Records",
      "usable": true
    },
    {
      "color": "Blue",
      "has_full_text_search": false,
      "id": "b6c5d0f2-1f39-4d5e-9b62-6a8a2a5f1c10",
      "is_default": true,
      "is_document_tray": true,
      "name": "Inbox",
      "usable": true
    }
  ]
}
```

### List my tasks

List the user's workflow tasks with their decisions: in one workflow, or in every workflow that has some.

**Inputs**

- DocuWare workflow (`docuware_workflow_id`, text): Only this workflow's tasks. Leave empty for all of them.
- How many (`count`, number): How many to return, 1 to 500. Defaults to 50. From 1 to 500.
- Skip (`start`, number): With a workflow chosen, how many tasks to skip, for the next page. Defaults to 0. At least 0.

**Outputs**

- `count` (number): How many tasks this step returned
- `tasks` (list): The tasks
- `total` (number): How many tasks there are in all

**Example output**

```json
{
  "count": 1,
  "tasks": [
    {
      "activity": "Approve invoice",
      "activity_type": "GeneralTask",
      "columns": {
        "COMPANY": "Example Supply Co.",
        "ReceivedOn": "2026-10-28T14:06:00Z"
      },
      "decisions": [
        {
          "description": "Approve the invoice",
          "form_fields": [
            {
              "description": "Why",
              "id": 3,
              "label": "Comment",
              "read_only": false,
              "required": false,
              "type": "Text"
            }
          ],
          "id": 1,
          "label": "Approve"
        },
        {
          "description": "Send it back",
          "form_fields": [],
          "id": 2,
          "label": "Reject"
        }
      ],
      "default_decision_id": 1,
      "document_id": 1234,
      "id": "8e0c1a52-3d4b-4bb4-9f5e-2c6d1e7a9b10",
      "instance_id": "b13d1794-b4b7-5e99-91d9-0bcaa13036f3",
      "is_read": false,
      "workflow_id": "29341189-7564-4194-ba2c-33963f41891f"
    }
  ],
  "total": 1
}
```

### List stamps

List the stamps the DocuWare user may place on a file cabinet's documents, such as Approved or Received.

**Inputs**

- File cabinet (`file_cabinet_id`, text, required): The file cabinet. Pick one, or give its id from an earlier step.

**Outputs**

- `count` (number): How many
- `stamps` (list): The stamps

**Example output**

```json
{
  "count": 1,
  "stamps": [
    {
      "form_fields": [
        {
          "label": "Comment",
          "name": "<#1>"
        }
      ],
      "id": "c4a3b2d1-0e9f-4a8b-7c6d-5e4f3a2b1c0d",
      "name": "Received",
      "password_protected": false,
      "type": "TextStamp"
    }
  ]
}
```

### List workflows

List the DocuWare workflows that have a task list for the user, with how many tasks each holds.

**Inputs**: None.

**Outputs**

- `count` (number): How many
- `workflows` (list): The workflows

**Example output**

```json
{
  "count": 1,
  "workflows": [
    {
      "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
      "id": "29341189-7564-4194-ba2c-33963f41891f",
      "name": "Invoice approval",
      "task_count": 2
    }
  ]
}
```

### Place stamp

Place a stamp, such as Approved, on a page of a document. DocuWare picks a free spot on the page.

**Inputs**

- File cabinet (`file_cabinet_id`, text, required): The file cabinet. Pick one, or give its id from an earlier step.
- Document ID (`document_id`, text, required): The document's id, a whole number, from a search, a list, a trigger or an earlier step.
- Stamp (`stamp_id`, text, required): The stamp to place.
- Stamp text (`stamp_text`, text): For a stamp that asks for text, the text to put on it.
- Page (`page`, number): The page to stamp. Defaults to the first. At least 1.

**Outputs**

- `annotation_count` (number): How many stamps and notes DocuWare reports on that page now
- `document_id` (number): The document stamped
- `page` (number): The page stamped
- `placed` (true/false): Always true once placed
- `stamp_id` (text): The stamp placed

**Example output**

```json
{
  "annotation_count": 1,
  "document_id": 1234,
  "page": 1,
  "placed": true,
  "stamp_id": "c4a3b2d1-0e9f-4a8b-7c6d-5e4f3a2b1c0d"
}
```

### Search documents

Find documents in a file cabinet by their index values and when they were stored. A value may use * as a wildcard, such as Exam*. Returns one page; pass 'next_start' as 'Skip' for more.

**Inputs**

- File cabinet (`file_cabinet_id`, text, required): The file cabinet. Pick one, or give its id from an earlier step.
- Index values (`conditions`, object): The values to look for, one per field. Fields left empty aren't searched. Use * as a wildcard, such as Exam*.
- Stored on or after (`stored_from`, date): Only documents stored on or after this date.
- Stored on or before (`stored_until`, date): Only documents stored on or before this date.
- Match (`match`, text): Whether a document must match every value (the default) or any of them. One of: `all` (Every condition (default)), `any` (Any condition).
- Search dialog (`search_dialog_id`, text): The search dialog to search with, which decides the fields you may search. Leave empty for the cabinet's default.
- Sort by (`sort_field`, text): The field to sort by. Defaults to when each was stored.
- Sort order (`sort_direction`, text): Descending (newest or highest first, the default) or ascending. One of: `Desc` (Descending (default)), `Asc` (Ascending).
- How many (`count`, number): How many to return, 1 to 500. Defaults to 50. From 1 to 500.
- Skip (`start`, number): How many to skip, for the next page: the 'next_start' of an earlier step. Defaults to 0. At least 0.

**Outputs**

- `count` (number): How many documents this page holds
- `documents` (list): The documents
- `has_more` (true/false): True when there are more to read
- `next_start` (number): The 'Skip' value for the next page
- `total` (number): How many documents match in all

**Example output**

```json
{
  "count": 1,
  "documents": [
    {
      "content_type": "application/pdf",
      "field_list": [
        {
          "is_null": false,
          "label": "Company",
          "name": "COMPANY",
          "read_only": false,
          "system_field": false,
          "type": "String",
          "value": "Example Supply Co."
        },
        {
          "is_null": false,
          "label": "Document date",
          "name": "DOCUMENT_DATE",
          "read_only": false,
          "system_field": false,
          "type": "Date",
          "value": "2026-10-20"
        },
        {
          "is_null": false,
          "label": "Stored on",
          "name": "DWSTOREDATETIME",
          "read_only": true,
          "system_field": true,
          "type": "DateTime",
          "value": "2026-10-28T14:05:00Z"
        }
      ],
      "fields": {
        "COMPANY": "Example Supply Co.",
        "DOCUMENT_DATE": "2026-10-20",
        "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
      },
      "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
      "file_size": 48213,
      "id": 1234,
      "is_checked_out": false,
      "is_data_record": false,
      "modified_at": "2026-10-28T14:05:00Z",
      "section_count": 1,
      "sections": [
        {
          "content_type": "application/pdf",
          "file_size": 48213,
          "id": "1234-5678",
          "original_file_name": "invoice-4711.pdf",
          "page_count": 2
        }
      ],
      "stored_at": "2026-10-28T14:05:00Z",
      "title": "Invoice 4711",
      "total_pages": 2,
      "version_status": "Disable"
    }
  ],
  "has_more": false,
  "next_start": 1,
  "total": 1
}
```

### Store document

Store a file in a file cabinet or document tray with its index values. Without a file it stores an index-only record (a data record).

**Inputs**

- File cabinet or document tray (`file_cabinet_id`, text, required): Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.
- File (`file`, text): The file to store: upload one, pick a file from an earlier step, or paste a public https link. Leave empty to store index values only.
- Index values (`fields`, object): Index values for the new document, one per field of the file cabinet. Dates use the date picker; for a keyword field give the keywords separated by commas. A document tray has none.
- Store dialog (`store_dialog_id`, text): The store dialog whose rules (required fields, default values) apply. Leave empty for the file cabinet's own rules.

**Outputs**

- `document` (object): The document
- `document_id` (number): The new document's id

**Example output**

```json
{
  "document": {
    "content_type": "application/pdf",
    "field_list": [
      {
        "is_null": false,
        "label": "Company",
        "name": "COMPANY",
        "read_only": false,
        "system_field": false,
        "type": "String",
        "value": "Example Supply Co."
      },
      {
        "is_null": false,
        "label": "Document date",
        "name": "DOCUMENT_DATE",
        "read_only": false,
        "system_field": false,
        "type": "Date",
        "value": "2026-10-20"
      },
      {
        "is_null": false,
        "label": "Stored on",
        "name": "DWSTOREDATETIME",
        "read_only": true,
        "system_field": true,
        "type": "DateTime",
        "value": "2026-10-28T14:05:00Z"
      }
    ],
    "fields": {
      "COMPANY": "Example Supply Co.",
      "DOCUMENT_DATE": "2026-10-20",
      "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
    },
    "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
    "file_size": 48213,
    "id": 1234,
    "is_checked_out": false,
    "is_data_record": false,
    "modified_at": "2026-10-28T14:05:00Z",
    "section_count": 1,
    "sections": [
      {
        "content_type": "application/pdf",
        "file_size": 48213,
        "id": "1234-5678",
        "original_file_name": "invoice-4711.pdf",
        "page_count": 2
      }
    ],
    "stored_at": "2026-10-28T14:05:00Z",
    "title": "Invoice 4711",
    "total_pages": 2,
    "version_status": "Disable"
  },
  "document_id": 1234
}
```

### Transfer document

Move a document from a document tray (or another file cabinet) into a file cabinet, with index values, as filing it in DocuWare does. Returns the filed document.

**Inputs**

- To file cabinet (`file_cabinet_id`, text, required): The file cabinet to file the document in.
- From (`source_file_cabinet_id`, text, required): The document tray or file cabinet the document is in now.
- Document ID (`document_id`, text, required): The document's id where it is now, from a list, a trigger or an earlier step.
- Index values (`fields`, object): Index values for the filed document, one per field of the file cabinet it goes to. Dates use the date picker.
- Keep a copy where it was (`keep_source`, true/false): Leave the original where it was. By default it is moved.
- Store dialog (`store_dialog_id`, text): The store dialog of the file cabinet it goes to. Leave empty for that cabinet's default.

**Outputs**

- `document` (object): The document
- `document_id` (number): The filed document's id in the file cabinet
- `documents` (list): Every document filed
- `kept_source` (true/false): True when the original was kept
- `source_document_id` (number): The document's id where it was

**Example output**

```json
{
  "document": {
    "content_type": "application/pdf",
    "field_list": [
      {
        "is_null": false,
        "label": "Company",
        "name": "COMPANY",
        "read_only": false,
        "system_field": false,
        "type": "String",
        "value": "Example Supply Co."
      },
      {
        "is_null": false,
        "label": "Document date",
        "name": "DOCUMENT_DATE",
        "read_only": false,
        "system_field": false,
        "type": "Date",
        "value": "2026-10-20"
      },
      {
        "is_null": false,
        "label": "Stored on",
        "name": "DWSTOREDATETIME",
        "read_only": true,
        "system_field": true,
        "type": "DateTime",
        "value": "2026-10-28T14:05:00Z"
      }
    ],
    "fields": {
      "COMPANY": "Example Supply Co.",
      "DOCUMENT_DATE": "2026-10-20",
      "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
    },
    "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
    "file_size": 48213,
    "id": 1234,
    "is_checked_out": false,
    "is_data_record": false,
    "modified_at": "2026-10-28T14:05:00Z",
    "section_count": 1,
    "sections": [
      {
        "content_type": "application/pdf",
        "file_size": 48213,
        "id": "1234-5678",
        "original_file_name": "invoice-4711.pdf",
        "page_count": 2
      }
    ],
    "stored_at": "2026-10-28T14:05:00Z",
    "title": "Invoice 4711",
    "total_pages": 2,
    "version_status": "Disable"
  },
  "document_id": 1234,
  "documents": [
    {
      "content_type": "application/pdf",
      "field_list": [
        {
          "is_null": false,
          "label": "Company",
          "name": "COMPANY",
          "read_only": false,
          "system_field": false,
          "type": "String",
          "value": "Example Supply Co."
        },
        {
          "is_null": false,
          "label": "Document date",
          "name": "DOCUMENT_DATE",
          "read_only": false,
          "system_field": false,
          "type": "Date",
          "value": "2026-10-20"
        },
        {
          "is_null": false,
          "label": "Stored on",
          "name": "DWSTOREDATETIME",
          "read_only": true,
          "system_field": true,
          "type": "DateTime",
          "value": "2026-10-28T14:05:00Z"
        }
      ],
      "fields": {
        "COMPANY": "Example Supply Co.",
        "DOCUMENT_DATE": "2026-10-20",
        "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
      },
      "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
      "file_size": 48213,
      "id": 1234,
      "is_checked_out": false,
      "is_data_record": false,
      "modified_at": "2026-10-28T14:05:00Z",
      "section_count": 1,
      "sections": [
        {
          "content_type": "application/pdf",
          "file_size": 48213,
          "id": "1234-5678",
          "original_file_name": "invoice-4711.pdf",
          "page_count": 2
        }
      ],
      "stored_at": "2026-10-28T14:05:00Z",
      "title": "Invoice 4711",
      "total_pages": 2,
      "version_status": "Disable"
    }
  ],
  "kept_source": false,
  "source_document_id": 87
}
```

### Update index values

Change a stored document's index values. Only the fields given change.

**Inputs**

- File cabinet (`file_cabinet_id`, text, required): The file cabinet. Pick one, or give its id from an earlier step.
- Document ID (`document_id`, text, required): The document's id, a whole number, from a search, a list, a trigger or an earlier step.
- Index values (`fields`, object, required): Index values to set, one per field of the file cabinet. Dates use the date picker; for a keyword field give the keywords separated by commas. Fields left empty are left as they are.

**Outputs**

- `changed` (list): The fields this step changed
- `document_id` (number): The document changed
- `field_list` (list): Every index field now
- `fields` (object): Every index field's database name with its value now

**Example output**

```json
{
  "changed": [
    "COMPANY"
  ],
  "document_id": 1234,
  "field_list": [
    {
      "is_null": false,
      "label": "Company",
      "name": "COMPANY",
      "read_only": false,
      "system_field": false,
      "type": "String",
      "value": "Example Supply Co."
    },
    {
      "is_null": false,
      "label": "Document date",
      "name": "DOCUMENT_DATE",
      "read_only": false,
      "system_field": false,
      "type": "Date",
      "value": "2026-10-20"
    }
  ],
  "fields": {
    "COMPANY": "Example Supply Co.",
    "DOCUMENT_DATE": "2026-10-20"
  }
}
```
