Bitrix API

CRM

Table of Contents

Methods

createDefaultRequisite()  : AddResult|Result
getCompanyCommunications()  : array<string|int, mixed>
Returns crm company communications.
getCompanySignature()  : File|null
Returns company signature.
getCompanyStamp()  : File|null
Returns company stamp.
getCompanyUrl()  : string
Returns company detail url.
getContactCommunications()  : array<string|int, mixed>
Returns crm contact communications.
getContactSignature()  : File|null
Returns contact signature.
getContactStamp()  : File|null
Returns contact stamp.
getContactUrl()  : string
Returns contact detail url.
getDirectorName()  : string|null
Returns director's name from requisites.
getEntityFields()  : array<string|int, mixed>
Returns full list of CRM entity fields.
getEntityFieldValue()  : array<string|int, mixed>|null
By field code resolves entity and returns its value from specified entity.
getFormCode()  : array<string|int, mixed>|null
Returns form html code.
getLinkedRequisites()  : array<string|int, mixed>|null
getMyDefaultPresetId()  : int|null
getNumeratorUrl()  : string|null
Returns url to open numerator settings.
getOtherSidePresetId()  : int|null
getOwnerTypeCompany()  : int
Returns crm owner type id for company.
getOwnerTypeContact()  : int
Returns crm owner type id for contact.
getRequisitesCompanyFieldSetId()  : int
Returns field set id for crm requisites for company.
getRequisitesCompanyFieldSetValues()  : array<string|int, mixed>
Returns crm requisites values for company.
getRequisitesContactFieldSetId()  : int
Returns field set id for crm requisites for contact.
getRequisitesContactFieldSetValues()  : array<string|int, mixed>
Returns crm requisites values for contact.
getRequisitesEntityFieldSetValues()  : array<string|int, mixed>
Returns crm requisites values for entity.
saveCompanySignature()  : bool
Saves company signature.
saveCompanyStamp()  : bool
Saves company stamp.
validatePresetFields()  : Result

Methods

createDefaultRequisite()

public static createDefaultRequisite(int $documentEntityId, int $entityId, int $entityType) : AddResult|Result
Parameters
$documentEntityId : int
$entityId : int
$entityType : int
Return values
AddResult|Result

getCompanyCommunications()

Returns crm company communications.

public static getCompanyCommunications(int $entityId) : array<string|int, mixed>
Parameters
$entityId : int

Entity id

Return values
array<string|int, mixed>

getCompanySignature()

Returns company signature.

public static getCompanySignature(int $companyId) : File|null
Parameters
$companyId : int

Company id.

Return values
File|null

getCompanyStamp()

Returns company stamp.

public static getCompanyStamp(int $companyId) : File|null
Parameters
$companyId : int

Company id.

Return values
File|null

getCompanyUrl()

Returns company detail url.

public static getCompanyUrl(string $id) : string
Parameters
$id : string

Company id or marker to replace.

Return values
string

getContactCommunications()

Returns crm contact communications.

public static getContactCommunications(int $entityId) : array<string|int, mixed>
Parameters
$entityId : int

Entity id

Return values
array<string|int, mixed>

getContactSignature()

Returns contact signature.

public static getContactSignature(int $contactId) : File|null
Parameters
$contactId : int

Contact id.

Return values
File|null

getContactStamp()

Returns contact stamp.

public static getContactStamp(int $contactId) : File|null
Parameters
$contactId : int

Contact id.

Return values
File|null

getContactUrl()

Returns contact detail url.

public static getContactUrl(string $id) : string
Parameters
$id : string

Contact id or marker to replace.

Return values
string

getDirectorName()

Returns director's name from requisites.

public static getDirectorName(int $companyId) : string|null
Parameters
$companyId : int

Company id.

Return values
string|null

getEntityFields()

Returns full list of CRM entity fields.

public static getEntityFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getEntityFieldValue()

By field code resolves entity and returns its value from specified entity.

public static getEntityFieldValue(int $entityId, string $fieldCode[, int|null $documentId = null ][, int|null $presetId = null ]) : array<string|int, mixed>|null
Parameters
$entityId : int

Entity id.

$fieldCode : string

Field code.

$documentId : int|null = null
$presetId : int|null = null
Tags
@return

array|null <text|src => ...>

Return values
array<string|int, mixed>|null

getFormCode()

Returns form html code.

public static getFormCode(string $documentHash, string $memberHash) : array<string|int, mixed>|null
Parameters
$documentHash : string

Document hash.

$memberHash : string

Member hash.

Return values
array<string|int, mixed>|null

getLinkedRequisites()

public static getLinkedRequisites(int $documentEntityId, string $requisiteField) : array<string|int, mixed>|null
Parameters
$documentEntityId : int
$requisiteField : string
Tags
throws
ArgumentException
Return values
array<string|int, mixed>|null

getMyDefaultPresetId()

public static getMyDefaultPresetId(int $documentEntityId[, int $companyId = 0 ][, int|null $documentEntityTypeId = null ][, bool $checkCrmPermissions = true ]) : int|null
Parameters
$documentEntityId : int
$companyId : int = 0
$documentEntityTypeId : int|null = null
$checkCrmPermissions : bool = true
Return values
int|null

getNumeratorUrl()

Returns url to open numerator settings.

public static getNumeratorUrl() : string|null
Return values
string|null

getOtherSidePresetId()

public static getOtherSidePresetId(int $documentEntityId) : int|null
Parameters
$documentEntityId : int
Tags
throws
ArgumentException
throws
LoaderException
Return values
int|null

getOwnerTypeCompany()

Returns crm owner type id for company.

public static getOwnerTypeCompany() : int
Return values
int

getOwnerTypeContact()

Returns crm owner type id for contact.

public static getOwnerTypeContact() : int
Return values
int

getRequisitesCompanyFieldSetId()

Returns field set id for crm requisites for company.

public static getRequisitesCompanyFieldSetId() : int
Return values
int

getRequisitesCompanyFieldSetValues()

Returns crm requisites values for company.

public static getRequisitesCompanyFieldSetValues(Document $document) : array<string|int, mixed>
Parameters
$document : Document
Tags
throws
LoaderException
Return values
array<string|int, mixed> —

Array<label, value>.

getRequisitesContactFieldSetId()

Returns field set id for crm requisites for contact.

public static getRequisitesContactFieldSetId() : int
Return values
int

getRequisitesContactFieldSetValues()

Returns crm requisites values for contact.

public static getRequisitesContactFieldSetValues(int $contactId, Document $document) : array<string|int, mixed>
Parameters
$contactId : int

Contact id.

$document : Document
Return values
array<string|int, mixed> —

Array<label, value>.

getRequisitesEntityFieldSetValues()

Returns crm requisites values for entity.

public static getRequisitesEntityFieldSetValues(int $entityTypeId, int $entityId, int $presetId) : array<string|int, mixed>
Parameters
$entityTypeId : int

Entity type id.

$entityId : int

Entity id.

$presetId : int
Return values
array<string|int, mixed>

saveCompanySignature()

Saves company signature.

public static saveCompanySignature(int $companyId, File $file) : bool
Parameters
$companyId : int

Company id.

$file : File

File instance.

Return values
bool

saveCompanyStamp()

Saves company stamp.

public static saveCompanyStamp(int $companyId, File $file) : bool
Parameters
$companyId : int

Company id.

$file : File

File instance.

Return values
bool

validatePresetFields()

public static validatePresetFields(int $presetId) : Result
Parameters
$presetId : int
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results