POST

Customer.PaymentForms.List

List payment forms assigned to one customer (customer profile Payment forms tab, table payment_forms_paid). Returns JSON rows with status Paid/Unpaid and payment_url.

Permissions

User must be logged in with a valid bearer token.
Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

Runs the Customer.PaymentForms.List 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

This lists customer instances (payment_forms_paid), not org templates. Templates: PaymentForms.List.
Set include_templates=1 to also return available templates for the assign dropdown.

Required Parameters

Name	Type	Sample	Explanation
`customer_id` post	int	`58`	Customer id. Alias: cust_id.

Optional Parameters

Name	Type	Sample	What it gives
`paid` post	int	`0`	Filter: 1=paid only, 0=unpaid only.
`include_templates` post	int	`1`	When 1, also return templates[] for assign dropdown.
`limit` post	int	`25`	Max rows (capped at 25).

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Customer.PaymentForms.List",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "customer_id": "58",
        "include_templates": "1"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Customer.PaymentForms.List",
    "url_domain": "https:\/\/{domain}\/app\/Customer.PaymentForms.List"
}

Endpoint

POST /app/Customer.PaymentForms.List
POST https://{user}.bull36.com/app/Customer.PaymentForms.List
POST https://{domain}/app/Customer.PaymentForms.List

Sample Output

{
    "success": 1,
    "customer_id": 58,
    "count": 1,
    "data": [
        {
            "id": 6184,
            "form_name": "Level transition payment",
            "amount": "65",
            "status": "Unpaid",
            "payment_url": "https:\/\/user.bull36.com\/dashboard\/home\/payment-form\/..."
        }
    ]
}

Count Only

Use the matching count route with the same filters when the UI only needs total rows for paging.

{
    "url": "\/app\/Customer.PaymentForms.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Customer.PaymentForms.Count",
    "url_domain": "https:\/\/{domain}\/app\/Customer.PaymentForms.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "customer_id": "58",
        "include_templates": "1"
    },
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "route": "Customer.PaymentForms.Count",
        "max_limit": 25
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('customer_id', '58');
body.set('include_templates', '1');

const res = await fetch('https://{domain}/app/Customer.PaymentForms.Count', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data.count);

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('customer_id', '58');
body.set('include_templates', '1');

const res = await fetch('/app/Customer.PaymentForms.List', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "Customer not found."
}