Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Sales Order

List sales order documents

Returns a list of given sales order documents

get/api/v1/salesOrders/{id}/documents

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Query parameters

key'id' | 'currentFileVersionId' | 'fileName'
op'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is'
numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

Response

Success

Example response

{
  "data": [
    {
      "id": "17",
      "entity": "salesOrder",
      "entityId": 1,
      "title": "Updated document",
      "description": "Sales order document",
      "keyword": "attachment",
      "sort": 1,
      "currentVersion": {
        "id": "17",
        "version": 1,
        "remark": "Initial version",
        "filename": "invoice_2024.pdf",
        "size": {
          "value": 210,
          "unit": "byte"
        },
        "updatedAt": "2024-09-18T14:30:00Z"
      },
      "updatedAt": "2024-09-18T14:30:00Z"
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}