Get a List of CRM Payer Types crm.persontype.list

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: crm

Who can execute the method: any user

DEPRECATED

The development of this method has been halted. Please use Universal Methods for Invoices.

This method returns a list of payer types.

Note

For payment systems used in CRM (for invoices, deals), payer types should be retrieved using the crm.persontype.list method. If a payment system is being created for orders, then the sale.persontype.list method should be used.

Name
type

Description

order

Sorting fields

filter

Filter fields

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"ID":"ASC"},"filter":{"NAME":"CRM_COMPANY"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.persontype.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"ID":"ASC"},"filter":{"NAME":"CRM_COMPANY"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.persontype.list
        
// callListMethod: Retrieves all data at once. Use only for small datasets (< 1000 items) due to high memory load.
        
        try {
          const response = await $b24.callListMethod(
            'crm.persontype.list',
            {
              order: { "ID": "ASC" },
              filter: {
                "NAME": "CRM_COMPANY",
              }
            },
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in chunks using an iterator. Use for large datasets for efficient memory consumption.
        
        try {
          const generator = $b24.fetchListMethod('crm.persontype.list', {
            order: { "ID": "ASC" },
            filter: {
              "NAME": "CRM_COMPANY",
            }
          }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Manual control of pagination through the start parameter. Use for precise control over request batches. Less efficient for large data than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.persontype.list', {
            order: { "ID": "ASC" },
            filter: {
              "NAME": "CRM_COMPANY",
            }
          }, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.persontype.list',
                    [
                        'order' => ['ID' => 'ASC'],
                        'filter' => [
                            'NAME' => 'CRM_COMPANY',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            if ($response->more()) {
                $response->next();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error listing payer types: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.persontype.list", {
                order: {"ID": "ASC"},
                filter: {
                    "NAME": "CRM_COMPANY",
                }
            },
            function (result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.dir(result.data());
                    if (result.more())
                        result.next();
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.persontype.list',
            [
                'order' => ['ID' => 'ASC'],
                'filter' => ['NAME' => 'CRM_COMPANY']
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.persontype.list", b24.Params{
        	"order": b24.Params{
        		"ID": "ASC",
        	},
        	"filter": b24.Params{
        		"NAME": "CRM_COMPANY",
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.persontype.list: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)