Sample Request

v1/documents/6cf38e81-07d3-4a72-ae16-032eb29a3a09

Sample Response

{
  "companyId": "EN",
  "docType": "PERSONNEL",
  "mimeType": "image/tiff",
  "id": "6cf38e81-07d3-4a72-ae16-032eb29a3a09",
  "status": "N",
  "revisionNo": 1,
  "fileContent": "[BASE64 Content]",
  "fileName": "TEST.tif",
  "checkoutUserId": "",
  "lastUpdate": {
    "updatedAt": "2005-10-10T12:12:00.000",
    "updatedBy": "SYSEN"
  },
  "docSize": 0,
  "indexes": [
    { "sequenceNo": 1, "indexValue": "EN" },
    { "sequenceNo": 2, "indexValue": "87010101" }
  ],
  "title": "TEST.tif",
  "description": ""
}

Limits & Notes

• One document per call.
• documentId must be a valid GUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Validation Rules for GET Method (Single)

Sample Request

• Get all documents (default pagination)
• Filter by doctype with custom limit
• Search by title prefix
• Filter by indexes
• Include file content

GET /v1/documents?companyId=EN

GET /v1/documents?companyId=EN&doctype=INVOICE&limit=50

GET /v1/documents?companyId=EN&title=report&start=0&limit=20

GET /v1/documents?companyId=EN&doctype=CONTRACT&indexes=EN

GET /v1/documents?companyId=EN&withFileContent=true&limit=5

Sample Response

{
  "start": 0,
  "limit": 10,
  "count": 10,
  "total": 42,
  "items": [
{
  "companyId": "EN",
  "docType": "PERSONNEL",
  "mimeType": "image/tiff",
  "id": "6cf38e81-07d3-4a72-ae16-032eb29a3a09",
  "status": "N",
  "revisionNo": 1,
  "fileName": "Copy of 00100205.tif",
  "checkoutUserId": "",
  "lastUpdate": {
    "updatedAt": "2005-10-10T12:12:00.000",
    "updatedBy": "SYSEN"
  },
  "docSize": 0,
  "indexes": [
    { "sequenceNo": 1, "indexValue": "EN" },
    { "sequenceNo": 2, "indexValue": "87010101" }
  ],
  "title": "Copy of 00100205.tif",
  "description": ""
}
  ]
}

Query Parameters

Retrieves documents array based on parameters.

Limits & Notes

• Returns array of document objects.
• doctype must be a valid attribute value configured in the ERPx.
• companyId must be a valid attribute value configured in the ERPx.
• Pagination envelope always includes: start, limit, count (items on this page), total (matching query).
• start is the zero-based index where results begin. For example, with 1,000 items and start = 100, the response returns items from index 100 onward (900 items).

Validation Rules for GET Method (Multiple)

Sample Request

[
  { 
    v1/documents/6cf38e81-07d3-4a72-ae16-032eb29a3a09/thumbnail?width=96&height=96 
  }
]

Sample Response

{
  "id": "6cf38e81-07d3-4a72-ae16-032eb29a3a09",
  "revisionNo": 1,
  "width": 96,
  "height": 96,
  "mimeType": "image/tiff",
  "fileName": "TEST.tif",
  "lastUpdate": {
    "updatedAt": "2025-10-28T14:45:16.000",
    "updatedBy": "SYSEN"
  },
  "fileContent": "base 64 Content
}

Additional parameters

Limits & Notes

• Retrieves document thumbnail based on its Id and CompanyId.
• One thumbnail per call.
• documentId must be a valid GUID.

Validation Rules for GET Method (thumbnails)

Sample Request

• Simple change - Update title
• Update multiple fields
• Update document index
• Update multiple indexes

[
  {
    "path": "description",
    "op": "replace",
    "value": "new description"
  }
]

[
  { "op": "replace", "path": "/title","value": "New title"},
  { "op": "replace", "path": "/description", "value": "New description"}
]

[
  { "op": "replace", "path": "/indexes/1/indexValue", "value": "87010101" }
]

[
  {
        "path": "indexes",
        "op": "replace",
                 "value": [
         {
            "SequenceNo": 1,
            "indexValue": "EN"
         },
         {
            "SequenceNo": 2,
            "indexValue": "87010101"
         }
     ] 
  }
]

Additional Parameters

Limits & Notes

• Updates document value based on its ID and company ID according to changes specified in the patch document.
• One document per call.
• Possibility to update several fields per call.
• Read-only fields: Cannot modify FileName, FileContent, MimeType, Status, DocSize, Id, RevisionNo, DocType.

Validation Rules for PATCH Method

Sample Request

DELETE /v1/documents/6cf38e81-07d3-4a72-ae16-032eb29a3a09

Additional Parameters

Limits & Notes

• Deletes document based on given document Id.
• One document per call.
• Soft delete: Status is changed to “T” (Terminated). Document is not physically removed from database.
• Document must belong to specified companyId to be deleted.
• Deleted documents may still be retrievable through archive queries depending on system configuration.

Validation Rules for DELETE Method

Sample Request

/v1/document-revisions/a9a66369-ceef-45c8-93ab-760e4e8e5db2/1

Sample Response

{
      "id": "a9a66369-ceef-45c8-93ab-760e4e8e5db2",
      "comment": "Revision comment",
      "fileContent":  “[BASE64 CONTENT]”,
      "fileName": "TEST_FILE.jpg",
      "revisionNo": 1,
      "mimeType": "image/jpeg",
      "lastUpdate": {
        "updatedAt": "2025-10-28T18:30:29.640",
        "updatedBy": "SYSEN"
      }
    }

Additional Parameters

Limits & Notes

• Id must be a valid document ID in GUID format.
• revisionNo must be a valid revision number.
• companyId must be a valid company attribute value.
• Response contains file content in base64.
• One revision per call.

Validation Rules for GET Method - Single Revision

Sample Request

/v1/document-revisions/a9a66369-ceef-45c8-93ab-760e4e8e5db2/1/thumbnail?width=96&height=96

Sample Response

{
  "id": "a9a66369-ceef-45c8-93ab-760e4e8e5db2",
  "revisionNo": 1,
  "width": 96,
  "height": 96,
  "mimeType": "image/jpeg",
  "fileName": "bird.jpg",
  "lastUpdate": {
    "updatedAt": "2025-10-28T18:30:29.000",
    "updatedBy": "SYSEN"
  },
  "fileContent": "[BASE 64 Content]”

}

Additional Parameters

Limits & Notes

• One thumbnail per call.
• documentId must be a valid GUID.
• revisionNo must be a valid number of revisions.

Validation Rules for GET Method - Thumbnail

Sample Request

{
  "id": "a9a66369-ceef-45c8-93ab-760e4e8e5db2",
  "comment": "New document",
  "fileContent":"[BASE 64 CONTENT]",
  "fileName": "TEST.jpg",
}

Limits & Notes

• One thumbnail per call.
• documentId must be a valid GUID.
• FileContent must be in base64.
• revisionNo cannot be passed - it is always the next value created by system (auto-incremented).

Validation Rules for POST Method