Customers

Retrieve customer documents list

Work with online customer documents list.Retrieves customer documents list.

get/admin/customers/customer-documents/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/customers/customer-documents/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the customer (parent). Returns the list of documents owned by this customer.

Response

idnumber
added_bystring
added_by_idnumber
customer_idnumber required
typestring required
titlestring required
created_atstring
updated_atstring
descriptionstring

Document description

visible_by_customerstring

Visibility on customer portal

filename_originalstring

Original document name

filename_uploadedstring

Uploaded document name

codestring

Document's code

sign_datestring

Signature date

contract_datestring

Date when contract starts (readonly for signed contracts)

terms_monthstring

Term (month)

end_of_termstring

End of term

sign_contractstring

Sign contract

termsboolean

This contract has a term

download_linkstring

A directly link to this document

has_thumbnailboolean

Whether this file has a thumbnail.

thumbnail_linkstring

A link to the document's thumbnail. The field is returned when has_thumbnail = true

Example response

[
  {
    "id": 1,
    "added_by": "api",
    "added_by_id": 1,
    "customer_id": 1,
    "type": "uploaded",
    "title": "customer document title",
    "created_at": "2017-01-01 16:05:28",
    "updated_at": "2017-01-02 12:12:43",
    "description": "document description",
    "visible_by_customer": "0",
    "filename_original": "SOME FILE NAME",
    "filename_uploaded": "SOME FILE NAME",
    "code": "file code",
    "sign_date": "2017-01-01 16:05:28",
    "terms_month": "1",
    "end_of_term": "2017-02-01",
    "sign_contract": "1",
    "terms": false,
    "download_link": "https://yourdomain/a",
    "has_thumbnail": true,
    "thumbnail_link": "https://yourdomain/b",
    "contract_date": "2017-01-01"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.