Documents

Add documents

post

/documents/

Each document record can contain the following data:

Parameter	Description	Required	Type
doc_name_ln	Pretty name of the file	Y	Varchar
doc_file_ln	Raw file name with extension	Y	Varchar
doc_data	Base 64 encoded file	Y	Base 64 encoded data
drn_type	Document relation type. Can by any of: 'TYPE','CUSTOMER','PROJECT','ADDRESS','OBJECT','QUOTATION','INVOICE'	Y	Varchar
drn_internal_reference	Document relation reference. Can be an array of string. The value should match to the relation type. For example obj_code(OBJECT) or debtor_number(CUSTOMER)	Y	Varchar or array
doc_active_ind	Indication if a document is active	N	Boolean (1 or 0)
doc_visibility	Indication if a document should be visible in the app	N	Boolean (1 or 0)
doc_workorder	Indiction if a document should be added to the workorder	N	Boolean (1 or 0)
doc_portal	Indication if a document should be visible in the portal (depending on drn_type)	N	Boolean (1 or 0)
doc_internal	Indication if a document is marked as internal	N	Boolean (1 or 0)

Possible errors:

Missing fields Invalid base64 data posted File extension not allowed Invalid drn_type posted

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tokenstringOptionalExample: {{client_token}}

software_tokenstringOptionalExample: {{software_token}}

Responses

200

Add documents

application/json

post/documents/

POST /documents/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Add documents

{
  "code": 200,
  "messages": [],
  "response": 1
}