POST
Customer.PaymentForms.Update
Update an unpaid customer payment form row (payment_forms_paid). Mirrors dashboard inline edit for amount/item on unpaid rows.
Permissions
- User must be logged in with a valid bearer token.
- The user must be from the same company domain as the request Host (call the API on that account subdomain or allowed custom domain). A token from another company returns success=0, error user_not_in_company.
- Returned or changed records are limited by the user permissions, team access, folder access, and account settings.
Action
- Runs the Customer.PaymentForms.Update function and returns JSON.
Push Service
No push is sent because this function only reads data or returns helper information.
Automation
No automation is run for this function.
Special Instructions
- Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
- On a company subdomain (e.g. https://{user_domain}.bull36.com) the user must match that Host — Login and protected APIs reject another company with success=0, error user_not_in_company. On a main brand host (bull36.com, biz1.co.il, mastrocrm.com, …) the company domain gate is skipped.
- Send parameters as POST body fields exactly as documented.
- Send date/time values in UTC Y-m-d H:i:s format when a date or datetime field is used.
Required Parameters
| Name | Type | Sample | Explanation |
|---|---|---|---|
customer_idpost | int | 58 | Customer id. Alias: cust_id. |
idpost | int | 6184 | payment_forms_paid row id. Aliases: payment_forms_paid_id, data_id. |
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
amountpost | string | 70 | New amount (not allowed when ask_to_customer=1 or row is paid). |
iteam_idpost | int | 120 | Linked item id. Aliases: item_id, payment_item_id. |
iteam_typepost | string | product | Item type when changing item. |
Authentication
Send the bearer token returned by Login in the request header. The user must be from the same company domain as this Host — a token from another company is rejected (user_not_in_company).
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/Customer.PaymentForms.Update",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"customer_id": "58",
"id": "6184",
"amount": "70"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Customer.PaymentForms.Update",
"url_domain": "https:\/\/{domain}\/app\/Customer.PaymentForms.Update"
}Endpoint
POST /app/Customer.PaymentForms.Update
POST https://{user}.bull36.com/app/Customer.PaymentForms.Update
POST https://{domain}/app/Customer.PaymentForms.UpdateSample Output
{
"success": 1,
"payment_forms_paid_id": 6184,
"message": "Customer payment form updated successfully."
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('customer_id', '58');
body.set('id', '6184');
body.set('amount', '70');
const res = await fetch('/app/Customer.PaymentForms.Update', {
method: 'POST',
headers: { Authorization: `Bearer ${token}` },
body
});
const data = await res.json();
console.log(data);Error Example
{
"success": 0,
"message": "Paid payment forms cannot be edited."
}