Explanation of how to use the pre-existing custom fields in Qoyod when connecting the system using API, with a practical example of how to send data.
Steps to follow:
Customer Response:
You can use custom fields when connecting via API, but with a condition:
-
You cannot create a new field via API
-
The field must be pre-added from the custom fields inside the system
Steps to Use Custom Fields with API:
-
Go to Settings > Custom Fields
-
Add the required fields according to document type (invoice, customer, supplier…)
-
After saving, use the following format in the connection:
Code Format:
],
"custom_fields": {
"customfield1": "custom value 1",
"customfield2": "custom value 2"
}
Practical Example:
],
"custom_fields": {
"اسم الفرع": "جده",
"اسم المندوب": "سعود"
}
Official API Documentation:
Additional Notes:
-
The field name in the code must be exactly the same as the one in the system
-
No additional activation steps are needed if the field is properly added and connected
