Get Unpaid Product Rows of CRM Object crm.item.productrow.getAvailableForPayment
Scope:
crmWho can execute the method: requires read access permission for the CRM object whose product rows are being selected.
The method retrieves product rows of the CRM object for which the client has not yet been billed.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
ownerId* |
Identifier of the CRM object |
|
ownerType* |
Identifier of the |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerType":"D","ownerId":13144}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.productrow.getAvailableForPayment
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerType":"D","ownerId":13144,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.productrow.getAvailableForPayment
try
{
const response = await $b24.callMethod(
'crm.item.productrow.getAvailableForPayment', {
ownerType: 'D',
ownerId: 13144,
}
);
const result = response.getData().result;
console.log(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'crm.item.productrow.getAvailableForPayment',
[
'ownerType' => 'D',
'ownerId' => 13144,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting available product rows for payment: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.productrow.getAvailableForPayment', {
ownerType: 'D',
ownerId: 13144,
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.item.productrow.getAvailableForPayment',
[
'ownerType' => 'D',
'ownerId' => 13144
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Successful Response
HTTP Status: 200
{
"result":{
"productRows":[
{
"id":17657,
"ownerId":13144,
"ownerType":"D",
"productId":9621,
"productName":"iphone 14",
"price":79999,
"priceAccount":79999,
"priceExclusive":79999,
"priceNetto":79999,
"priceBrutto":79999,
"quantity":3,
"discountTypeId":2,
"discountRate":0,
"discountSum":0,
"taxRate":null,
"taxIncluded":"Y",
"customized":"Y",
"measureCode":796,
"measureName":"pcs",
"sort":10,
"xmlId":"sale_basket_8149",
"type":4
},
{
"id":17658,
"ownerId":13144,
"ownerType":"D",
"productId":9623,
"productName":"iphone 10xs",
"price":5550,
"priceAccount":5550,
"priceExclusive":5550,
"priceNetto":5550,
"priceBrutto":5550,
"quantity":3,
"discountTypeId":2,
"discountRate":0,
"discountSum":0,
"taxRate":null,
"taxIncluded":"Y",
"customized":"Y",
"measureCode":796,
"measureName":"pcs",
"sort":20,
"xmlId":"sale_basket_8150",
"type":4
}
]
},
"time":{
"start":1716966560.3205,
"finish":1716966560.742781,
"duration":0.42228102684020996,
"processing":0.17676782608032227,
"date_start":"2024-05-29T10:09:20+02:00",
"date_finish":"2024-05-29T10:09:20+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
productRows |
Array of objects containing information about all product rows of the CRM object for which the client has not yet been billed |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error":"ACCESS_DENIED",
"error_description":"Access denied"
}
|
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 parameters 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
- Product Items
- Add Product Row to CRM Object crm.item.productrow.add
- Get the list of fields for product rows crm.item.productrow.fields
- Get information about a product item by id crm.item.productrow.get
- Save Product Row of CRM Object crm.item.productrow.set
- Update the product row of a CRM object crm.item.productrow.update
- Get product rows of the CRM object crm.item.productrow.list
- Delete product row from CRM object crm.item.productrow.delete