Get Document Fields crm.documentgenerator.document.getfields

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":101,"values":{"DocumentNumber":"2026-001"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.getfields
        

// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type DocumentField = {
          title: string
          value: string | unknown[] | null
          default?: string | null
          required?: string
          type?: string
          group?: string[]
          chain?: string | string[]
          format?: Record<string, unknown>
          options?: Record<string, unknown>
          hideRow?: string
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type DocumentFieldsResult = {
          documentFields: Record<string, DocumentField>
        }
        
        try {
          const response = await $b24.actions.v2.call.make<DocumentFieldsResult>({
            method: 'crm.documentgenerator.document.getfields',
            params: {
              id: 101,
              values: {
                DocumentNumber: '2026-001',
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info(Object.keys(result.documentFields), result.documentFields)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getDocumentFields() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.documentgenerator.document.getfields',
                params: {
                  id: 101,
                  values: {
                    DocumentNumber: '2026-001',
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info(Object.keys(result.documentFields), result.documentFields)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getDocumentFields)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.documentgenerator.document.getfields(
                bitrix_id=101,
                values={
                    "DocumentNumber": "2026-001",
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API Error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK Error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.document.getfields',
                    [
                        'id' => 101,
                        'values' => [
                            'DocumentNumber' => '2026-001',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting document fields: ' . $e->getMessage();
        }
        

BX24.callMethod(
            'crm.documentgenerator.document.getfields',
            {
                id: 101,
                values: {
                    DocumentNumber: '2026-001',
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        

require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.document.getfields',
            [
                'id' => 101,
                'values' => [
                    'DocumentNumber' => '2026-001',
                ],
            ]
        );
        
        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.documentgenerator.document.getfields", b24.Params{
        	"id": 101,
        	"values": b24.Params{
        		"DocumentNumber": "2026-001",
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.documentgenerator.document.getfields: %w", err)
        }
        
        // The method wraps the response in an object with the "documentFields" key.
        raw, ok := b24.Unwrap(res.Result, "documentFields")
        if !ok {
        	return fmt.Errorf("no documentFields key in the response")
        }
        
        fmt.Printf("%s\n", raw)