Get the list of payments crm.item.payment.list
Scope:
crmWho can execute the method: requires read access permission for the CRM object from which payments are selected.
The method retrieves a list of payments for a specific CRM object.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
entityId* |
Identifier of the CRM object |
|
entityTypeId* |
Identifier of the |
|
filter |
Additional filter for cases when you need to get not all payments of the entity, but based on a more specific filter. The format description is provided in the filter parameter of the |
|
order |
The format description is provided in the order parameter of the |
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
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
try {
const response = await $b24.callListMethod(
'crm.item.payment.list',
{
entityId: 13123,
entityTypeId: 2,
filter: {
"@id": [1036, 1037]
}
},
(progress) => { console.log('Progress:', progress) }
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
// fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
try {
const generator = $b24.fetchListMethod('crm.item.payment.list', {
entityId: 13123,
entityTypeId: 2,
filter: {
"@id": [1036, 1037]
}
}, 'ID');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity); }
}
} catch (error) {
console.error('Request failed', error);
}
// callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
try {
const response = await $b24.callMethod('crm.item.payment.list', {
entityId: 13123,
entityTypeId: 2,
filter: {
"@id": [1036, 1037]
}
}, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', 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>';
Successful Response
HTTP status: 200
{
"result":[
{
"id":1036,
"accountNumber":"3653\/1",
"paid": "Y",
"datePaid":"2024-05-20T12:32:02+02:00",
"empPaidId":1,
"paySystemId":6,
"sum":0,
"currency":"USD",
"paySystemName":"Cash"
},
{
"id":1037,
"accountNumber":"3653\/2",
"paid": "N",
"datePaid":null,
"empPaidId":null,
"paySystemId":6,
"sum":0,
"currency":"USD",
"paySystemName":"Cash"
}
],
"time":{
"start":1716205783.285524,
"finish":1716205783.702053,
"duration":0.41652917861938477,
"processing":0.15817594528198242,
"date_start":"2024-05-20T14:49:43+02:00",
"date_finish":"2024-05-20T14:49:43+02:00"
}
}
Returned Data
|
Name |
Description |
|
Array of objects containing brief information about the selected payments |
|
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error":0,
"error_description":"Insufficient permissions"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Access denied |
|
|
Required fields not provided |
|
|
Other errors (e.g., fatal errors) |
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- 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