Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
File

List files for a document

Returns a collection with all files for a document.

get/api/v2/{documentType}/{id}/files

Path parameters

documentType'salesOrders' | 'liabilities' | 'returns' | 'invoices' | 'creditNotes' | 'purchaseOrders' | 'offers' | 'priceInquiries' | 'proformaInvoices' | 'deliveryNotes' | 'productions' | 'serviceOrders' | 'tickets' required

The type of the document

idinteger required

The identifier for the document

Query parameters

key'keyword' | 'title'
op'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'

Filters applied to the query. Only 'keyword' and 'title' are allowed as filter keys.

[
  {
    "key": "keyword"
  }
]

Response

Operation completed successfully.

Example response

{
  "data": [
    {
      "id": "17",
      "entity": "invoice",
      "entityId": 1234,
      "title": "Invoice Document",
      "description": "Document for invoice 1234",
      "keyword": "attachment",
      "sort": 1,
      "currentVersion": {
        "id": "1",
        "version": 4,
        "remark": "Please process this quickly",
        "filename": "document-2024-1234.pdf",
        "size": {
          "value": 2684,
          "unit": "byte"
        },
        "updatedAt": "2023-01-01T00:00:00+00:00"
      },
      "updatedAt": "2024-06-04T12:00:00+00:00"
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}