Payments in Universal CRM Objects: Overview of Methods

The methods in this section work with payments associated with universal CRM objects. For example, you can create a payment for a deal, mark the receipt of funds, or generate a payment link for the client.

This is necessary to synchronize the status and parameters of payments in the CRM with external payment systems. Bitrix24 stores payment data separately from the main fields of the object but links them through identifiers.

Quick navigation: all methods

Linking Payments to Other ObjectsLinking Payments to Other Objects

CRM Object. To create and retrieve a list of payments, use the parameter pair entityTypeId and entityId. The first indicates the type of CRM object, while the second refers to a specific element of that type.

Payment Systems. The payment data returns paySystemId and paySystemName. You can access available payment systems using the sale.paysystem.list method.

Payment Line Items. Each payment can contain a set of line items. To manage the composition of the payment, use the methods in the section Line Items in Payment.

Delivery Items. A payment can be linked to delivery items. To work with them, use the methods in the section Deliveries in Payments.

How to Work with Payments in CRMHow to Work with Payments in CRM

1. Define the CRM object type entityTypeId and its identifier entityId.
2. Create a payment using the crm.item.payment.add method.
3. If necessary, add products to the payment using the methods in the section Line Items in Payment or delivery services using the methods in the section Deliveries in Payments.
4. Retrieve the list of payments for the object using the crm.item.payment.list method and select the desired payment by id.
5. Get the details of a specific payment using the crm.item.payment.get method and update the data if necessary using the crm.item.payment.update method.
6. Change the payment status using the crm.item.payment.pay or crm.item.payment.unpay methods.
7. If a payment link for the client is needed, use salescenter.payment.getPublicUrl.
8. If the payment is no longer needed, delete it using the crm.item.payment.delete method.

Limitations and FeaturesLimitations and Features

• For the crm.item.payment.* methods, a correct pair of entityTypeId and entityId for the CRM object is required.
• The methods crm.item.payment.product.* and crm.item.payment.delivery.* only work with an existing payment by paymentId.
• In list methods, apply filter and order in a format compatible with sale.payment.list.
• The salescenter.payment.getPublicUrl method works in the salescenter scope and is used only for generating a public link.

Overview of MethodsOverview of Methods

Scope: crm, salescenter

Who can execute the methods: depending on the method

Main Payment MethodsMain Payment Methods

Method	Description
crm.item.payment.add	Creates a payment for a CRM object
crm.item.payment.update	Modifies the set of payment fields
crm.item.payment.get	Returns brief information about the payment
crm.item.payment.list	Returns a list of payments for a specific CRM object
crm.item.payment.delete	Deletes a payment
crm.item.payment.pay	Changes the payment status to "Paid"
crm.item.payment.unpay	Changes the payment status to "Unpaid"

Public Payment LinkPublic Payment Link

Method	Description
salescenter.payment.getPublicUrl	Generates a public payment link

Line Items in PaymentLine Items in Payment

Method	Description
crm.item.payment.product.add	Adds a line item to the payment
crm.item.payment.product.list	Returns a list of line items in the payment
crm.item.payment.product.delete	Deletes a line item from the payment
crm.item.payment.product.setQuantity	Changes the quantity of a product in the payment line item

Deliveries in PaymentsDeliveries in Payments

Method	Description
crm.item.payment.delivery.add	Adds a delivery item to the payment
crm.item.payment.delivery.list	Returns a list of delivery items for a specific payment
crm.item.payment.delivery.delete	Deletes a delivery item from the payment
crm.item.payment.delivery.setDelivery	Reassigns a delivery item to another delivery document