Product Items in Payment: Overview of Methods
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
The methods in this section manage product items within CRM payments. For example, you can add a specific product to a payment, change its quantity, or remove it from the payment.
This is necessary to detail the composition of the order in financial documents. Bitrix24 links products from the catalog with payments, allowing for accurate accounting of items during transactions.
Quick navigation: all methods
Linking Product Items in Payment with Other Objects
CRM Payment. All methods in this section are executed in the context of a payment identified by paymentId.
Product Catalog. Serves as the source of information about the product. Data from the catalog is transferred to the CRM product line and is then used when forming the item in the payment.
CRM Product Line. The methods in this section work with the product line through rowId. The product line contains data about the product: identifier, name, quantity, price, unit of measurement, and other parameters. You can obtain rowId using the method crm.item.productrow.list. Within the payment, you can only manage the quantity of the product.
How to Work with Product Items in Payment
- Prepare the
paymentIdof the desired payment using the main methods from the section crm.item.payment.*. - Add a product item using the method crm.item.payment.product.add.
- Check the composition of the items using the method crm.item.payment.product.list.
- If necessary, adjust the quantity using the method crm.item.payment.product.setQuantity or remove the item using the method crm.item.payment.product.delete.
Overview of Methods
Scope:
crmWho can execute the methods: depending on the method
|
Method |
Description |
|
Adds a product item to the payment |
|
|
Returns a list of product items in the payment |
|
|
Removes a product item from the payment |
|
|
Changes the quantity of the product in the payment item |