Adding a Product Item to Payment crm.item.payment.product.add

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: a user with "edit" access permission for the CRM object associated with the payment. The payment must not be paid

The method crm.item.payment.product.add adds a product from a deal or invoice product row to a payment. The payment amount increases by the product price multiplied by quantity.

Method Parameters

Required parameters are marked with *

Name
type

Description

paymentId*
sale_order_payment.id

Identifier of the payment. You can retrieve the payment identifiers of a CRM object using the crm.item.payment.list method

rowId*
integer

Identifier of the product row of the deal or invoice that the payment belongs to. You can retrieve it using the crm.item.productrow.list method — the id field in the response

quantity*
integer

Product quantity — an integer from 1 to the unallocated remainder of the product row. The remainder is the quantity in the product row minus the quantity of this product in all payments of the order.

If the product has already been fully allocated to other payments, the method returns the Product was not found. error

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"paymentId":1039,"rowId":17587,"quantity":2}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.payment.product.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"paymentId":1039,"rowId":17587,"quantity":2,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.item.payment.product.add
        
// 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
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'crm.item.payment.product.add',
            params: {
              paymentId: 1039,
              rowId: 17587,
              quantity: 2,
            },
            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('Added product row id:', result)
          }
        } 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 addPaymentProduct() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.item.payment.product.add',
                params: {
                  paymentId: 1039,
                  rowId: 17587,
                  quantity: 2,
                },
                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('Added product row id:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addPaymentProduct)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.item.payment.product.add(
                payment_id=1039,
                row_id=17587,
                quantity=2,
            ).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.item.payment.product.add',
                    [
                        'paymentId' => 1039,
                        'rowId'     => 17587,
                        'quantity'  => 2
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding payment product: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.item.payment.product.add', {
                paymentId: 1039,
                rowId: 17587,
                quantity: 2
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.item.payment.product.add',
            [
                'paymentId' => 1039,
                'rowId' => 17587,
                'quantity' => 2
            ]
        );
        
        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.item.payment.product.add", b24.Params{
        	"paymentId": 1039,
        	"rowId":     17587,
        	"quantity":  2,
        })
        if err != nil {
        	return fmt.Errorf("crm.item.payment.product.add: %w", err)
        }
        
        var id int
        if err := json.Unmarshal(res.Result, &id); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("item ID:", id)
        

Response Handling

HTTP status: 200

{
           "result":1193,
           "time":{
              "start":1716276648.349503,
              "finish":1716276649.261574,
              "duration":0.9120709896087646,
              "processing":0.6422691345214844,
              "date_start":"2024-05-21T10:30:48+03:00",
              "date_finish":"2024-05-21T10:30:49+03:00"
           }
        }
        

Returned Data

Name
type

Description

result
integer

Identifier of the created product item in the payment. Use it in the crm.item.payment.product.setQuantity and crm.item.payment.product.delete methods

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "0",
            "error_description": "Insufficient product stock."
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

0

Product quantity must be greater than zero

A value of 0 or less was passed in quantity

400

0

Insufficient product stock

The total quantity of this product in all payments would exceed the quantity in the product row of the CRM object

400

0

Product was not found

The CRM object that the payment belongs to has no product row with the passed rowId, or the product has already been fully allocated to payments

400

0

Payment has not been found

The payment with the passed paymentId was not found

400

ACCESS_DENIED

Access denied

The payment is already paid, or the user does not have permission to modify the payment. To change the contents of a paid payment, first call crm.item.payment.unpay

400

0

Order binding has not been found

The payment's order is not linked to a CRM object

400

0

Entity does not support links with catalog products

The CRM object that the payment belongs to does not support products

400

100

Could not find value for parameter {parameter name}

The required parameter paymentId, rowId, or quantity was not provided

The method returns code 0 for several different errors. To determine the cause, check the text in error_description.

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning