{"id":444451,"date":"2026-04-03T02:43:16","date_gmt":"2026-04-03T00:43:16","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/rest-api-file-management\/"},"modified":"2026-04-03T02:43:16","modified_gmt":"2026-04-03T00:43:16","password":"","slug":"rest-api-file-management","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-file-management\/","title":{"rendered":"REST API – File Management"},"content":{"rendered":"

Uploading a file involves several steps: create a document, upload the file, then link them.<\/p>\n

\n

Step 1: Get the Folder’s Webservice ID<\/h2>\n

To create a document, you need the Webservice ID of the target folder. Use a query<\/code> operation: <\/p>\n

Curl example:<\/strong><\/p>\n

curl \"https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=query&sessionName=YOUR_SESSION_ID&query=SELECT%20id%20FROM%20DocumentFolders%20WHERE%20foldername%20LIKE%20'Default'%20LIMIT%201%20;\"\n<\/code><\/pre>\n
Request:<\/strong><\/p>\n
SELECT id FROM DocumentFolders WHERE foldername LIKE 'Default' LIMIT 1 ;\n<\/code><\/pre>\n
\n
Step 2: Create a Document Entity<\/h2>\n
Create a Documents<\/code> type entity via the create<\/code> operation.<\/p>\n
\n
POST<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMust be  create<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\nyes<\/td>\nSession ID<\/td>\n<\/tr>\n
element<\/code><\/td>\nJSON<\/td>\nyes<\/td>\nDocument JSON object (see fields below)<\/td>\n<\/tr>\n
elementType<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMust be  Documents<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
element<\/code> object fields:<\/strong><\/p>\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Field<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
notes_title<\/code><\/td>\nstring<\/td>\nyes<\/td>\nDocument entity name<\/td>\n<\/tr>\n
folderid<\/code><\/td>\nstring<\/td>\nyes<\/td>\nFolder Webservice ID (step 1)<\/td>\n<\/tr>\n
filename<\/code><\/td>\nstring<\/td>\nyes<\/td>\nFile name<\/td>\n<\/tr>\n
filetype<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMIME type (e.g., application\/pdf<\/code>)<\/td>\n<\/tr>\n
filesize<\/code><\/td>\nint<\/td>\nyes<\/td>\nFile size in bytes<\/td>\n<\/tr>\n
filestatus<\/code><\/td>\nint<\/td>\nyes<\/td>\n1<\/code>  for active<\/td>\n<\/tr>\n
filelocationtype<\/code><\/td>\nstring<\/td>\nyes<\/td>\nI<\/code>  for internal storage<\/td>\n<\/tr>\n
assigned_user_id<\/code><\/td>\nstring<\/td>\nyes<\/td>\nAssigned user’s Webservice ID<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Curl example:<\/strong><\/p>\n
curl -X POST https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php \\\n  -d \"operation=create\" \\\n  -d \"sessionName=YOUR_SESSION_ID\" \\\n  -d 'element={\"notes_title\":\"Mon document\",\"folderid\":\"65x1\",\"filename\":\"rapport.pdf\",\"filetype\":\"application\/pdf\",\"filesize\":12345,\"filestatus\":1,\"filelocationtype\":\"I\",\"assigned_user_id\":\"19x1\"}' \\\n  -d \"elementType=Documents\"\n<\/code><\/pre>\n
\n
Step 3: Upload the file (FileUpload)<\/h2>\n
This operation uploads the file and links it to the created document. It can also be used alone to add images to products (replace attachmentType<\/code> with Image<\/code> and parentId<\/code> with the product’s Webservice ID). <\/p>\n
\n
POST<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMust be  FileUpload<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\nyes<\/td>\nSession ID<\/td>\n<\/tr>\n
parentId<\/code><\/td>\nstring<\/td>\nyes<\/td>\nDocument Webservice ID (step 2)<\/td>\n<\/tr>\n
attachmentType<\/code><\/td>\nstring<\/td>\nyes<\/td>\nAttachment<\/code>  for a file, Image<\/code> for an image<\/td>\n<\/tr>\n
fileName<\/code><\/td>\nstring<\/td>\nyes<\/td>\nFile name<\/td>\n<\/tr>\n
fileContents<\/code><\/td>\nstring<\/td>\nyes<\/td>\nFile content encoded in base64<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Curl example:<\/strong><\/p>\n
curl -X POST https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php \\\n  -d \"operation=FileUpload\" \\\n  -d \"sessionName=YOUR_SESSION_ID\" \\\n  -d \"parentId=15x7890\" \\\n  -d \"attachmentType=Attachment\" \\\n  -d \"fileName=rapport.pdf\" \\\n  -d \"fileContents=$(base64 -w0 rapport.pdf)\"\n<\/code><\/pre>\n
\n
Retrieve a file (files_retrieve)<\/h2>\n
Retrieves a file previously added to Kafinea. You need the WebserviceID of the file<\/strong> (not to be confused with that of the Document entity). <\/p>\n
\n
GET<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMust be  files_retrieve<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\nyes<\/td>\nSession ID<\/td>\n<\/tr>\n
id<\/code><\/td>\nstring<\/td>\nyes<\/td>\nFile Webservice ID<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Curl example:<\/strong><\/p>\n
curl \"https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=files_retrieve&sessionName=YOUR_SESSION_ID&id=28x5678\"\n<\/code><\/pre>\n
\n
Related references \ud83d\udd17<\/h2>\n