crm.documentgenerator.document.list

crm.documentgenerator.document.list(select = ['*'], order = [], filter = [], start = 0)

The method returns list of documents by the filter.

Parameters

Parameter	Description
select	array of fields to be printed.
order	array to specify printing sequence `{"id": "desc"}`.
filter	array for filtration.
start	offset for pagewise navigation.

Filter example

"filter": {
  "entityTypeId": 2,
  "entityId": 5
}

List of documents is returned as a result, generated for the deal with ID=5.

Response

"documents": [
    "0": {
        "id": "1523",
        "title": "Act (PL)  1",
        "number": "1",
        "templateId": "115",
        "entityTypeId": "2",
        "fileId": "4315",
        "imageId": "4316",
        "pdfId": "4317",
        "createTime": "2018-06-05T16:04:40+02:00",
        "updateTime": "2018-06-05T16:04:40+02:00",
        "values": {},
        "entityId": "5",
        "downloadUrl": "",
        "downloadUrlMachine": "",
        "imageUrl": "",
        "imageUrlMachine": "",
        "pdfUrl": "",
        "pdfUrlMachine": "",
    }
]