REST API – CRUD Operations

---

ListTypes — List available modules #

This operation returns all modules accessible via the API.

GET https://apps.kafinea.com/{instance}/webservice.php

Curl example:

curl "https://apps.kafinea.com/YourKafinea/webservice.php?operation=listtypes&sessionName=YOUR_SESSION_ID"

---

Describe — Describing a module #

This operation allows you to view a module's fields (type, required status) and the available actions.

GET https://apps.kafinea.com/{instance}/webservice.php

Curl example:

curl "https://apps.kafinea.com/YourKafinea/webservice.php?operation=describe&sessionName=YOUR_SESSION_ID&elementType=Contacts"

---

Retrieve — Retrieve an entity #

Retrieves a specific entity by its Web service ID (e.g., 21x3456).

GET https://apps.kafinea.com/{instance}/webservice.php

Curl example:

curl "https://apps.kafinea.com/YourKafinea/webservice.php?operation=retrieve&sessionName=YOUR_SESSION_ID&id=21x3456"

---

Create — Create an entity #

Creates a new entity in a module. All required fields must be included. Field values linked to other modules must use the Webservice IDs format (e.g., 21x3456).

POST https://apps.kafinea.com/{instance}/webservice.php

Curl example:

curl -X POST https://apps.kafinea.com/YourKafinea/webservice.php \
  -d "operation=create" \
  -d "sessionName=YOUR_SESSION_ID" \
  -d 'element={"lastname":"Dupont","email":"dupont@example.com","assigned_user_id":"19x1"}' \
  -d "elementType=Contacts"

Warning! For inventory-related modules (invoices, quotes, orders, etc.), the following fields must be included in the object element :

• productid — Product Web Service ID
• hdnTaxType — Individual or Group
• LineItems — List of products or services

---

Update — Update an entity #

Updates an existing entity. All fields must be included (not just the modified ones). The object element must contain the entity's Web Service ID (e.g., "id": "21x3456").

POST https://apps.kafinea.com/{instance}/webservice.php

Curl example:

curl -X POST https://apps.kafinea.com/YourKafinea/webservice.php \
  -d "operation=update" \
  -d "sessionName=YOUR_SESSION_ID" \
  -d 'element={"id":"21x3456","lastname":"Dupont","email":"nouveau@example.com","assigned_user_id":"19x1"}' \
  -d "elementType=Contacts"

Partial Edit on locked entities #

If you need to modify certain fields on locked records (Permanent Lock, such as a invoice ), you can use partial editing without unlocking the record.

POST https://apps.kafinea.com/{instance}/webservice.php

Operation and restrictions:

• Allowed fields: status, assigned user, order references, and all custom fields.
• Locked product lines: Any changes to items, prices, or quantities (line items) are ignored in partial edit mode.
• Error handling: without the flag partial_edit=1, the API returns ACCESSDENIED. If the module does not support this mode: ACCESSDENIED – Partial edit is not supported for module X.

Warning! Even in partial_edit, the object element must contain all required fields of the module, just like with a standard update.

Curl example:

curl -X POST https://apps.kafinea.com/YourKafinea/webservice.php \
  -d "operation=update" \
  -d "sessionName=YOUR_SESSION_ID" \
  -d "partial_edit=1" \
  -d 'element={"id":"7x1234","invoicestatus":"Paid","assigned_user_id":"19x1"}' \
  -d "elementType=Invoice"

---

Delete — Delete an entity #

Deletes a specific entity by its Web Service ID (e.g., 21x3456).

POST https://apps.kafinea.com/{instance}/webservice.php

Curl example:

curl -X POST https://apps.kafinea.com/YourKafinea/webservice.php \
  -d "operation=delete" \
  -d "sessionName=YOUR_SESSION_ID" \
  -d "id=21x3456"

---

Related references 🔗 #

• API Introduction
• Authentication
• Related transactions
• Requests and inquiries