Config

Download document

Download document.

get/admin/config/download/{module}--{document_id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/config/download/{module}--{document_id}
  • Auth: HTTP basic

Path parameters

modulestring required

The module type. Module types list:

  • af: Documents from additional fields with type file

  • lead_documents: Lead documents

  • customer_documents: Customer documents

  • uploads: Uploaded documents

  • ticket_attachment: Ticket attachments

  • invoices: Invoice documents

  • invoices_export: Invoices export

  • invoices_charge: Invoices charge

  • credit_notes: Credit note documents

  • credit_notes_export: Credit notes export

  • requests: Proforma invoice documents

  • requests_export: Proforma invoice export

  • requests_charge: Proforma invoice charge

  • payments: Payment documents

  • payments_export: Payments export

  • cdr: CDR history documents

  • inventory_supplier_invoices: Inventory supplier invoice documents

  • inventory_items: Inventory item documents

  • inventory_products: Inventory product documents

  • cards_export: Cards export

  • admins_avatar: Admins avatar (document_id must be id of desired admin)

document_idnumber double required
Example:1

The ID of the document

Query parameters

af_modulestring required
Example:locations

Additional field module. Used only with module af

fieldstring required
Example:zip_code

Additional field name. Used only with module af

cards_type'CardsPrepaid' | 'CardsRefill' required

Cards type. Used only with module cards_export

Response

namestring

Documents name

content_typestring

Content type

contentstring

Document content encoded in base64 format

Example response

{
  "name": "test_document.pdf",
  "content_type": "application\\/pdf",
  "content": "VBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlIC9QYWdlC..."
}

Changes

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