Skip to content

crm-quote-get.md

Latest commit

 

History

History
366 lines (304 loc) · 9.54 KB

crm-quote-get.md

File metadata and controls

366 lines (304 loc) · 9.54 KB
Raw

Get Estimate by ID: crm.quote.get

{% note tip "" %}

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.

{% endnote %}

Scope: crm

Who can execute the method: a user with "read" access permission for estimates

{% note warning "DEPRECATED" %}

The development of this method has been halted. Please use crm.item.get.

{% endnote %}

The method crm.quote.get returns an estimate by its ID.

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || id* integer | The ID of the estimate.

The ID can be obtained using the methods crm.quote.list and crm.quote.add || |#

Code Examples

{% include Note on examples %}

Example of retrieving an estimate with id = 43.

{% list tabs %}

  • cURL (Webhook)

    curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":43}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.quote.get

  • cURL (OAuth)

    curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":43,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.quote.get

  • JS (TS)

    // 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 the payload returned in result (match the "response handling" section of the page)
type QuoteData = {
  ID: string
  TITLE: string
  STATUS_ID: string
  CURRENCY_ID: string
  OPPORTUNITY: string
  TAX_VALUE: string
  COMPANY_ID: string | null
  CONTACT_ID: string | null
  MYCOMPANY_ID: string | null
  BEGINDATE: ISODate | null
  CLOSEDATE: ISODate | null
  ACTUAL_DATE: ISODate | null
  ASSIGNED_BY_ID: string
  CREATED_BY_ID: string
  MODIFY_BY_ID: string
  DATE_CREATE: ISODate
  DATE_MODIFY: ISODate
  OPENED: string
  CLOSED: string
  COMMENTS: string | null
  LEAD_ID: string | null
  DEAL_ID: string | null
  QUOTE_NUMBER: string
}

try {
  const response = await $b24.actions.v2.call.make<QuoteData>({
    method: 'crm.quote.get',
    params: {
      id: 43,
    },
    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(result.ID, result.TITLE, result.STATUS_ID)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

  • JS (UMD)

    <!-- 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 getQuote() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.quote.get',
        params: {
          id: 43,
        },
        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(result.ID, result.TITLE, result.STATUS_ID)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getQuote)
</script>

  • PHP

    try {
    $response = $b24Service
        ->core
        ->call(
            'crm.quote.get',
            [
                'id' => 43,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo '<pre>';
    print_r($result);
    echo '</pre>';

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting estimate: ' . $e->getMessage();
}

  • BX24.js

    BX24.callMethod(
    'crm.quote.get',
    {
        id: 43,
    },
    (result) => {
        result.error()
            ? console.error(result.error())
            : console.info(result.data())
        ;
    },
);

  • PHP CRest

    require_once('crest.php');

$result = CRest::call(
    'crm.quote.get',
    [
        'id' => 43,
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

  • Go

    // client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.quote.get", b24.Params{
	"id": 43,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.quote.get: %w", err)
}

var item struct {
	ID          b24.ID `json:"ID"`
	Title       string `json:"TITLE"`
	StatusID    string `json:"STATUS_ID"`
	CurrencyID  string `json:"CURRENCY_ID"`
	Opportunity string `json:"OPPORTUNITY"`
	TaxValue    string `json:"TAX_VALUE"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.Title)

{% endlist %}

Response Handling

HTTP Status: 200

{
    "result": {
        "ID": "43",
        "TITLE": "Estimate for Furniture Supply",
        "STATUS_ID": "SENT",
        "CURRENCY_ID": "EUR",
        "OPPORTUNITY": "150000.00",
        "TAX_VALUE": "0.00",
        "COMPANY_ID": "1",
        "CONTACT_ID": null,
        "MYCOMPANY_ID": "340",
        "BEGINDATE": "2026-03-13T03:00:00+01:00",
        "CLOSEDATE": "2026-03-20T03:00:00+01:00",
        "ACTUAL_DATE": "2026-03-20T03:00:00+01:00",
        "ASSIGNED_BY_ID": "1",
        "CREATED_BY_ID": "577",
        "MODIFY_BY_ID": "577",
        "DATE_CREATE": "2026-03-13T13:15:37+01:00",
        "DATE_MODIFY": "2026-03-13T16:56:07+01:00",
        "OPENED": "Y",
        "CLOSED": "N",
        "COMMENTS": "Conditions and deadlines clarified",
        "LEAD_ID": null,
        "DEAL_ID": null,
        "QUOTE_NUMBER": "43",
        "CONTENT": null,
        "TERMS": null,
        "PERSON_TYPE_ID": "1",
        "LOCATION_ID": null,
        "CLIENT_TITLE": null,
        "CLIENT_ADDR": null,
        "CLIENT_CONTACT": null,
        "CLIENT_EMAIL": null,
        "CLIENT_PHONE": null,
        "CLIENT_TP_ID": null,
        "CLIENT_TPA_ID": null,
        "UTM_SOURCE": null,
        "UTM_MEDIUM": null,
        "UTM_CAMPAIGN": null,
        "UTM_CONTENT": null,
        "UTM_TERM": null,
        "PARENT_ID_136": null,
        "LAST_COMMUNICATION_TIME": null,
        "LAST_ACTIVITY_BY": "577",
        "LAST_ACTIVITY_TIME": "2026-03-13T13:15:37+01:00",
        "UF_CRM_566EB0AC9B7FC": "",
        "UF_CRM_566EB0AFA9895": "0",
        "UF_CRM_566EB0AFB84F1": "Online Store",
        "UF_CRM_566EB0AFC58FD": "0",
        "UF_CRM_566EB0AFDA4EF": "",
        "UF_CRM_566EB0AFEDB2F": "",
        "UF_CRM_566EB0B014EC2": "",
        "UF_CRM_566EB0B0231B2": "",
        "UF_CRM_566EB0B02F46F": "",
        "UF_CRM_566EB0B03CDCD": "",
        "UF_CRM_566EB0B04D190": "267",
        "UF_CRM_577BBCE34CC90": "",
        "UF_CRM_577BBCE354F86": ""
    },
    "time": {
        "start": 1773411068,
        "finish": 1773411068.183631,
        "duration": 0.18363094329833984,
        "processing": 0,
        "date_start": "2026-03-13T17:11:08+01:00",
        "date_finish": "2026-03-13T17:11:08+01:00",
        "operating_reset_at": 1773411668,
        "operating": 0
    }
}

Returned Data

#| || Name type | Description || || result object | The root element of the response. Contains fields of the estimate.

The set and types of fields can be obtained using the method crm.quote.fields || || time time | Information about the request execution time || |#

Error Handling

HTTP Status: 400

{
    "error": "",
    "error_description": "Not found"
}

{% include notitle error handling %}

Possible Error Codes

#| || Code | Description | Value || || Empty value | ID is not defined or invalid. | An incorrect id was provided || || Empty value | Access denied. | The user does not have permission to read estimates || || Empty value | Not found | The estimate with the provided id was not found || |#

{% include system errors %}

Continue Learning