Get the List of Payments crm.item.payment.list
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:
crmWho can execute the method: requires read access permission for the CRM object from which payments are selected.
The crm.item.payment.list method returns all payments of a deal or invoice in a single response, without pagination.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
entityId* |
Identifier of the deal or invoice. You can retrieve the identifier using the crm.item.list method |
|
entityTypeId* |
Identifier of the CRM object type. Only two types have payments:
For other types, the method returns an empty array |
|
filter |
Filter by payment fields in the You can add an operator prefix to the key:
For example, |
|
order |
Sorting in the
Defaults to |
The method does not support the start parameter: all payments of the object are returned in a single response.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityId":13123,"entityTypeId":2,"filter":{"@id":[1036,1037]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.payment.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityId":13123,"entityTypeId":2,"filter":{"@id":[1036,1037]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.payment.list
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each payment item returned in result[]
type PaymentItem = {
id: number
accountNumber: string
paid: 'Y' | 'N'
datePaid: ISODate | null
empPaidId: number | null
paySystemId: number
sum: number
currency: string
paySystemName: string
}
try {
// crm.item.payment.list returns all records in one response, without pagination
const response = await $b24.actions.v2.call.make<PaymentItem[]>({
method: 'crm.item.payment.list',
params: {
entityId: 13123,
entityTypeId: 2,
filter: {
'@id': [1036, 1037],
},
},
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('Payments:', result.length, 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 loadPaymentList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.item.payment.list returns all records in one response, without pagination
const response = await $b24.actions.v2.call.make({
method: 'crm.item.payment.list',
params: {
entityId: 13123,
entityTypeId: 2,
filter: {
'@id': [1036, 1037],
},
},
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('Payments:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', loadPaymentList)
</script>
Example
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.payment.list(
entity_id=13123,
entity_type_id=2,
filter={
"@id": [1036, 1037],
},
).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}")
Example as_list
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.payment.list(
entity_id=13123,
entity_type_id=2,
filter={
"@id": [1036, 1037],
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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.list',
[
'entityId' => 13123,
'entityTypeId' => 2,
'filter' => [
"@id" => [1036, 1037]
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching payment list: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.payment.list', {
entityId: 13123,
entityTypeId: 2,
filter: {
"@id": [1036, 1037]
},
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.item.payment.list',
[
'entityId' => 13123,
'entityTypeId' => 2,
'filter' => [
'@id' => [1036, 1037]
]
]
);
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.list", b24.Params{
"entityId": 13123,
"entityTypeId": 2,
"filter": b24.Params{
"@id": []int{1036, 1037},
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.item.payment.list: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
AccountNumber string `json:"accountNumber"`
Paid string `json:"paid"`
DatePaid string `json:"datePaid"`
EmpPaidID b24.ID `json:"empPaidId"`
PaySystemID b24.ID `json:"paySystemId"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.AccountNumber)
}
// Total and Next are filled in by list methods; for a full
// list traversal, use client.Core().Pages and Scan.
if res.Total != nil {
fmt.Println("total:", *res.Total)
}
Response Handling
HTTP status: 200
{
"result": [
{
"id": 1036,
"accountNumber": "1049/1",
"paid": "Y",
"datePaid": "2026-10-28T16:59:33+01:00",
"empPaidId": 1,
"paySystemId": 11,
"sum": 3000,
"currency": "USD",
"paySystemName": "Cash"
},
{
"id": 1037,
"accountNumber": "1049/2",
"paid": "N",
"datePaid": null,
"empPaidId": null,
"paySystemId": 19,
"sum": 3000,
"currency": "USD",
"paySystemName": "PayPal"
}
],
"time": {
"start": 1793203179,
"finish": 1793203179.129769,
"duration": 0.12976908683776855,
"processing": 0,
"date_start": "2026-10-28T16:59:39+01:00",
"date_finish": "2026-10-28T16:59:39+01:00",
"operating_reset_at": 1793203740,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
Array of payments of the CRM object (detailed description). If there are no payments, an empty array is returned |
|
|
time |
Information about the request execution time |
sale_order_payment_crm_simple
|
Name |
Description |
|
Payment identifier |
|
|
accountNumber |
Payment number in the |
|
paid |
Payment status:
|
|
datePaid |
Date and time when the payment was last marked as paid. The value is kept after crm.item.payment.unpay |
|
empPaidId |
Identifier of the user who last marked the payment as paid. The value is kept after crm.item.payment.unpay |
|
paySystemId |
Payment system identifier |
|
sum |
Payment amount. It is recalculated automatically when products and delivery are added to or removed from the payment |
|
currency |
Payment currency |
|
paySystemName |
Name of the payment system |
Error Handling
HTTP status: 400
{
"error": "100",
"error_description": "Could not find value for parameter {entityId}"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Could not find value for parameter { |
The required parameter |
|
|
|
Internal server error. |
A field that the payment does not have was passed in |
|
|
|
Access denied |
No permission to read the CRM object |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Payments in Universal CRM Objects: Overview of Methods
- Product Items in Payment: Overview of Methods
- Deliveries in Payments: Overview of Methods
- Update Payment Fields crm.item.payment.update
- Delete Payment crm.item.payment.delete
- Get Payment Information crm.item.payment.get
- Change Payment Status to "Paid" crm.item.payment.pay
- Change Payment Status to "Unpaid" crm.item.payment.unpay
- Add Payment crm.item.payment.add
- How to Save the Payment Date in the Deal Field