---
title: "List sales order documents"
method: GET
path: "/api/v1/salesOrders/{id}/documents"
tags: ["Sales Order"]
deprecated: true
---

# List sales order documents

`GET /api/v1/salesOrders/{id}/documents`

> **Deprecated.**

Returns a list of given sales order documents

## Path parameters

- `id` string, required — Resource identifier.

## Query parameters

- `filter` object[]
  - `key` 'id' | 'currentFileVersionId' | 'fileName'
  - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is'
  - `value` union
    - string — Used for the operations 'equals', 'notEquals', 'contains', 'notContains', 'startsWith', 'endsWith' and 'is'.
    - string[] — Used for the operations 'in', 'notIn', 'exactlyIn', 'allIn' and 'allNotIn'.
- `page` object
  - `number` string, required — Page number should be an integer greater than or equal to 1
  - `size` string, required — Page size should usually be an integer between 10 and 50.

## Response `200`

Success

- object
  - `data` object[]
    - `id` string — Resource identifier.
    - `entity` string
    - `entityId` integer
    - `title` string, nullable
    - `description` string, nullable
    - `keyword` string, nullable
    - `sort` integer
    - `currentVersion` object
      - `id` string — Resource identifier.
      - `version` integer
      - `remark` string, nullable
      - `filename` string
      - `size` object
        - `value` integer, required
        - `unit` 'byte', required — Currently only byte as unit allowed.
      - `updatedAt` string, date-time
    - `updatedAt` string, date-time
  - `extra` object
    - `totalCount` integer, required — the total count of all items
    - `page` object, required — The pagination object containing the current page number and size
      - `number` integer, required — The current page number
      - `size` integer, required — The size of the pages

## Other responses

- `403` — Unable to authorize the client
- `404` — Resource was not found or not enough access privileges
- `406` — Requested resource representation does not exist.
- `415` — Resource representation send in the request is not supported.
- `429` — Too many API calls made.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)
