Bitrix API

DocumentService

Table of Contents

Methods

__construct()  : mixed
canBeChanged()  : bool
canEditBlank()  : bool
changeBlank()  : Result
Change blank for document
configureAndStart()  : Result|ConfigureResult
Configure and start signing process
getById()  : Document|null
getByUid()  : Document|null
Get document by uid or null if not found
getComposedTitleByDocument()  : string
getDocumentEntity()  : Dummy|null
getLastByBlankId()  : Document|null
Get last document by blank id
getLastCreatedEmployeeDocumentFromDocuments()  : Document|null
getMyCompanyIdByDocument()  : int|null
getSignDocumentBySmartDocumentId()  : Document|null
getTitleWithAutoNumber()  : string
isCurrentUserCanEditDocument()  : bool
listMyCompanyIdsForDocuments()  : array<int, int>
makeDocumentTitle()  : string
modifyCompanyUid()  : Result
modifyExternalDate()  : Result
modifyExternalId()  : Result
modifyHcmLinkCompanyId()  : Result|null
modifyInitiatedByType()  : Result
modifyInitiator()  : Result
modifyLangId()  : Result
modifyProviderCode()  : Result
modifyRegionDocumentType()  : Result
modifyRepresentativeId()  : Result
modifyScheme()  : Result
modifyTitle()  : Result
refreshEntityNumber()  : Result
register()  : Result
resolveDocumentByCrmEntity()  : Document|null
rollbackDocument()  : Result
rollbackDocumentByUid()  : Result
setCheckPermission()  : DocumentService
setResultFileId()  : Result
unsetEntityId()  : Result
upload()  : Result
Upload document file to signing server

Methods

__construct()

public __construct([DocumentRepository|null $documentRepository = null ][, BlankService|null $blankService = null ][, BlankRepository|null $blankRepository = null ][, EventHandlerService|null $eventHandlerService = null ][, bool $checkPermission = true ][, ProviderCodeService|null $providerCodeService = null ][, TemplateRepository|null $documentTemplateRepository = null ][, TemplateService|null $documentTemplateService = null ][, MemberRepository|null $memberRepository = null ]) : mixed
Parameters
$documentRepository : DocumentRepository|null = null
$blankService : BlankService|null = null
$blankRepository : BlankRepository|null = null
$eventHandlerService : EventHandlerService|null = null
$checkPermission : bool = true
$providerCodeService : ProviderCodeService|null = null
$documentTemplateRepository : TemplateRepository|null = null
$documentTemplateService : TemplateService|null = null
$memberRepository : MemberRepository|null = null

changeBlank()

Change blank for document

public changeBlank(string $uid, int $blankId) : Result
Parameters
$uid : string
$blankId : int
Return values
Result

getByUid()

Get document by uid or null if not found

public getByUid(string $uid) : Document|null
Parameters
$uid : string
Tags
throws
ObjectPropertyException
throws
SystemException
throws
ArgumentException
Return values
Document|null

getLastByBlankId()

Get last document by blank id

public getLastByBlankId(int $blankId) : Document|null
Parameters
$blankId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
Document|null

getSignDocumentBySmartDocumentId()

public getSignDocumentBySmartDocumentId(int $entityId) : Document|null
Parameters
$entityId : int
Return values
Document|null

makeDocumentTitle()

public makeDocumentTitle(string $title, Blank $blank, Dummy|null $entity) : string
Parameters
$title : string
$blank : Blank
$entity : Dummy|null
Return values
string

modifyCompanyUid()

public modifyCompanyUid(string $documentUid, string $companyUid) : Result
Parameters
$documentUid : string
$companyUid : string
Return values
Result

modifyExternalDate()

public modifyExternalDate(string $documentUid, string $externalDate) : Result
Parameters
$documentUid : string
$externalDate : string
Return values
Result

modifyExternalId()

public modifyExternalId(string $documentUid, string $externalId) : Result
Parameters
$documentUid : string
$externalId : string
Return values
Result

modifyHcmLinkCompanyId()

public modifyHcmLinkCompanyId(string $documentUid[, int|null $hcmLinkCompanyId = null ]) : Result|null
Parameters
$documentUid : string
$hcmLinkCompanyId : int|null = null
Return values
Result|null

modifyInitiator()

public modifyInitiator(string $uid, string $initiator) : Result
Parameters
$uid : string
$initiator : string
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
Result

modifyLangId()

public modifyLangId(string $uid, string $langId) : Result
Parameters
$uid : string
$langId : string
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
Result

modifyProviderCode()

public modifyProviderCode(Document $document, string $providerCode) : Result
Parameters
$document : Document
$providerCode : string
Return values
Result

modifyRegionDocumentType()

public modifyRegionDocumentType(string $documentUid, string $regionDocumentType) : Result
Parameters
$documentUid : string
$regionDocumentType : string
Return values
Result

modifyRepresentativeId()

public modifyRepresentativeId(string $documentUid, int $representativeId) : Result
Parameters
$documentUid : string
$representativeId : int
Return values
Result

modifyScheme()

public modifyScheme(string $documentUid, string $scheme) : Result
Parameters
$documentUid : string
$scheme : string
Return values
Result

modifyTitle()

public modifyTitle(string $uid, string $title) : Result
Parameters
$uid : string
$title : string
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
Result

register()

public register(int $blankId[, string $title = '' ][, int|null $entityId = null ][, string|null $entityType = null ][, bool $asTemplate = false ][, InitiatedByType $initiatedByType = InitiatedByType::COMPANY ][, int $createdById = 0 ][, int $chatId = 0 ][, int|null $templateId = null ]) : Result
Parameters
$blankId : int
$title : string = ''
$entityId : int|null = null
$entityType : string|null = null
$asTemplate : bool = false
$initiatedByType : InitiatedByType = InitiatedByType::COMPANY
$createdById : int = 0
$chatId : int = 0
$templateId : int|null = null
Return values
Result

resolveDocumentByCrmEntity()

public resolveDocumentByCrmEntity(string $entityType, int $entityId) : Document|null
Parameters
$entityType : string
$entityId : int
Return values
Document|null

rollbackDocument()

public rollbackDocument(int $documentId) : Result
Parameters
$documentId : int
Return values
Result

rollbackDocumentByUid()

public rollbackDocumentByUid(string $uid) : Result
Parameters
$uid : string
Return values
Result

setResultFileId()

public setResultFileId(Document $document, int $resultFileId) : Result
Parameters
$document : Document
$resultFileId : int
Return values
Result

upload()

Upload document file to signing server

public upload(string $uid) : Result
Parameters
$uid : string
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results