Skip to content

Latest commit

 

History

History
287 lines (228 loc) · 7.43 KB

File metadata and controls

287 lines (228 loc) · 7.43 KB

Delete Bank Detail crm.requisite.bankdetail.delete

{% 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 "delete" access permission for the contact or company that owns the requisite

This method deletes a bank detail.

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || id* integer | Identifier of the bank detail. Bank detail identifiers can be obtained using the method crm.requisite.bankdetail.list || |#

Code Examples

{% include Note on examples %}

{% list tabs %}

  • cURL (Webhook)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"id":357}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.bankdetail.delete
  • cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"id":357,"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/crm.requisite.bankdetail.delete
  • 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 } from '@bitrix24/b24jssdk'
    
    declare const $b24: B24Frame
    
    try {
      const response = await $b24.actions.v2.call.make<boolean>({
        method: 'crm.requisite.bankdetail.delete',
        params: {
          id: 357,
        },
        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('Bank detail deleted:', result)
      }
    } 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 deleteBankDetail() {
        try {
          // Initialize the SDK inside a Bitrix24 frame
          const $b24 = await B24Js.initializeB24Frame()
    
          const response = await $b24.actions.v2.call.make({
            method: 'crm.requisite.bankdetail.delete',
            params: {
              id: 357,
            },
            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('Bank detail deleted:', result)
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
      }
    
      document.addEventListener('DOMContentLoaded', deleteBankDetail)
    </script>
  • Python

    from b24pysdk.errors import BitrixAPIError, BitrixSDKException
    
    try:
        bitrix_response = client.crm.requisite.bankdetail.delete(bitrix_id=357).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}")
  • PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'crm.requisite.bankdetail.delete',
                [
                    'id' => 357,
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        if ($result->error()) {
            error_log($result->error());
        } else {
            echo 'Success: ' . print_r($result->data(), true);
        }
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error deleting bank detail: ' . $e->getMessage();
    }
  • BX24.js

    BX24.callMethod(
        "crm.requisite.bankdetail.delete",
        { id: 357 },
        function(result)
        {
            if(result.error())
                console.error(result.error());
            else
                console.info(result.data());
        }
    );
  • PHP CRest

    require_once('crest.php');
    
    $result = CRest::call(
        'crm.requisite.bankdetail.delete',
        ['id' => 357]
    );
    
    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.requisite.bankdetail.delete", b24.Params{
    	"id": 357,
    })
    if err != nil {
    	return fmt.Errorf("crm.requisite.bankdetail.delete: %w", err)
    }
    
    var ok bool
    if err := json.Unmarshal(res.Result, &ok); err != nil {
    	return fmt.Errorf("parse response: %w", err)
    }
    fmt.Println("done:", ok)

{% endlist %}

Response Handling

HTTP status: 200

{
    "result": true,
    "time": {
        "start": 1716554949.294631,
        "finish": 1716554949.795059,
        "duration": 0.5004279613494873,
        "processing": 0.057311058044433594,
        "date_start": "2024-05-24T14:49:09+02:00",
        "date_finish": "2024-05-24T14:49:09+02:00",
        "operating": 0
    }
}

Returned Data

#| || Name type | Description || || result boolean | Result of deleting the bank detail:

  • true — deleted
  • false — not deleted || || time time | Information about the request execution time || |#

Error Handling

HTTP status: 40x, 50x

{
    "error": "",
    "error_description": "The RequisiteBankDetail with ID '357' is not found"
}

{% include notitle Error handling %}

Possible Error Codes

#| || Error text | Description || || ID is not defined or invalid | The identifier of the bank detail is not specified or has an invalid value || || The RequisiteBankDetail with ID '357' is not found | The bank detail with the specified identifier was not found || || Access denied | Insufficient access permissions to delete the bank detail || |#

{% include System errors %}

Continue Learning