Get a list of payer types crm.persontype.list

Scope: crm

Who can execute the method: any user

Warning

The method is deprecated. It is recommended to use Universal methods for invoices

The method returns a list of payer types.

Note

For payment systems used in CRM (for invoices, deals), payer types should be retrieved through 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 selections (< 1000 items) due to high memory usage.
        
        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 parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        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: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient 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 person 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>';