Bitrix API

CheckManager

FinalYes

Class CheckManager

Table of Contents

Constants

CHECK_LIMIT_RECORDS  = 5
CHECK_RESENDING_TIME  = 4
This is time re-sending a check print in minutes
EVENT_ON_BEFORE_CHECK_ADD_VERIFY  = 'OnBeforeCheckAddVerify'
EVENT_ON_CHECK_COLLATE_DOCUMENTS  = 'OnCheckCollateDocuments'
EVENT_ON_CHECK_PRINT_ERROR  = 'OnCheckPrintError'
EVENT_ON_CHECK_PRINT_SEND  = 'OnPrintableCheckSend'
EVENT_ON_CHECK_VALIDATION_ERROR  = 'OnCheckValidationError'
EVENT_ON_GET_CUSTOM_CHECK  = 'OnGetCustomCheckList'
MIN_TIME_FOR_SWITCH_CASHBOX  = 240

Methods

addByType()  : Result
addChecks()  : Result
addCorrection()  : mixed
collateDocuments()  : array<string|int, Entity>
collectInfo()  : array<string|int, mixed>
create()  : Check|null
createByType()  : null|Check
delete()  : mixed
getCheckInfo()  : array<string|int, mixed>
getCheckInfoByExternalUuid()  : array<string|int, mixed>|false
getCheckList()  : array<string|int, mixed>
getCheckTypeMap()  : array<string|int, mixed>
getLastPrintableCheckInfo()  : array<string|int, mixed>|false
getList()  : Result
getObjectById()  : Check|null
getOrder()  : Order
getPaymentByCheck()  : Payment
Returns payment by check
getPrintableChecks()  : array<string|int, mixed>
getRelatedEntitiesForPayment()  : array<string|int, mixed>
getRelatedEntitiesForShipment()  : array<string|int, mixed>
getSalesCheckList()  : mixed
init()  : void
isAvailableCorrection()  : bool
reprint()  : Result
savePrintResult()  : Result

Constants

CHECK_LIMIT_RECORDS

public mixed CHECK_LIMIT_RECORDS = 5

CHECK_RESENDING_TIME

This is time re-sending a check print in minutes

public mixed CHECK_RESENDING_TIME = 4

EVENT_ON_BEFORE_CHECK_ADD_VERIFY

public mixed EVENT_ON_BEFORE_CHECK_ADD_VERIFY = 'OnBeforeCheckAddVerify'

EVENT_ON_CHECK_COLLATE_DOCUMENTS

public mixed EVENT_ON_CHECK_COLLATE_DOCUMENTS = 'OnCheckCollateDocuments'

EVENT_ON_CHECK_PRINT_ERROR

public mixed EVENT_ON_CHECK_PRINT_ERROR = 'OnCheckPrintError'

EVENT_ON_CHECK_PRINT_SEND

public mixed EVENT_ON_CHECK_PRINT_SEND = 'OnPrintableCheckSend'

EVENT_ON_CHECK_VALIDATION_ERROR

public mixed EVENT_ON_CHECK_VALIDATION_ERROR = 'OnCheckValidationError'

EVENT_ON_GET_CUSTOM_CHECK

public mixed EVENT_ON_GET_CUSTOM_CHECK = 'OnGetCustomCheckList'

MIN_TIME_FOR_SWITCH_CASHBOX

public mixed MIN_TIME_FOR_SWITCH_CASHBOX = 240

Methods

addCorrection()

public static addCorrection(mixed $type, mixed $cashboxId, array<string|int, mixed> $correction) : mixed
Parameters
$type : mixed
$cashboxId : mixed
$correction : array<string|int, mixed>

collateDocuments()

public static collateDocuments(array<string|int, mixed> $entities) : array<string|int, Entity>
Parameters
$entities : array<string|int, mixed>
Tags
throws
NotSupportedException
Return values
array<string|int, Entity>

collectInfo()

public static collectInfo([array<string|int, mixed> $filter = array() ]) : array<string|int, mixed>
Parameters
$filter : array<string|int, mixed> = array()
Tags
throws
ArgumentException
throws
NotImplementedException
Return values
array<string|int, mixed>

create()

public static create(array<string|int, mixed> $settings) : Check|null
Parameters
$settings : array<string|int, mixed>
Return values
Check|null

createByType()

public static createByType(string $type) : null|Check
Parameters
$type : string
Return values
null|Check

delete()

public static delete(mixed $id) : mixed
Parameters
$id : mixed
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException

getCheckInfo()

public static getCheckInfo(CollectableEntity $entity) : array<string|int, mixed>
Parameters
$entity : CollectableEntity
Tags
throws
ArgumentException
throws
NotImplementedException
Return values
array<string|int, mixed>

getCheckInfoByExternalUuid()

public static getCheckInfoByExternalUuid(mixed $uuid) : array<string|int, mixed>|false
Parameters
$uuid : mixed
Tags
throws
ArgumentException
Return values
array<string|int, mixed>|false

getCheckList()

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

getCheckTypeMap()

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

getLastPrintableCheckInfo()

public static getLastPrintableCheckInfo(CollectableEntity $entity) : array<string|int, mixed>|false
Parameters
$entity : CollectableEntity
Tags
throws
ArgumentException
Return values
array<string|int, mixed>|false

getList()

public static getList([array<string|int, mixed> $parameters = array() ]) : Result
Parameters
$parameters : array<string|int, mixed> = array()
Tags
throws
ArgumentException
Return values
Result

getObjectById()

public static getObjectById(mixed $id) : Check|null
Parameters
$id : mixed
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
Check|null

getPaymentByCheck()

Returns payment by check

public static getPaymentByCheck(Check $check) : Payment
Parameters
$check : Check
Return values
Payment

getPrintableChecks()

public static getPrintableChecks(array<string|int, mixed> $cashboxIds[, array<string|int, mixed> $orderIds = array() ]) : array<string|int, mixed>
Parameters
$cashboxIds : array<string|int, mixed>
$orderIds : array<string|int, mixed> = array()
Tags
throws
ArgumentException
throws
SqlQueryException
throws
ObjectException
throws
SystemException
throws
Exception
Return values
array<string|int, mixed>

getRelatedEntitiesForPayment()

public static getRelatedEntitiesForPayment(mixed $checkType, mixed $paymentId[, string $registryType = SaleRegistry::REGISTRY_TYPE_ORDER ]) : array<string|int, mixed>
Parameters
$checkType : mixed
$paymentId : mixed
$registryType : string = SaleRegistry::REGISTRY_TYPE_ORDER
Tags
throws
ArgumentException
throws
ArgumentTypeException
Return values
array<string|int, mixed>

getRelatedEntitiesForShipment()

public static getRelatedEntitiesForShipment(mixed $checkType, mixed $shipmentId[, string $registryType = SaleRegistry::REGISTRY_TYPE_ORDER ]) : array<string|int, mixed>
Parameters
$checkType : mixed
$shipmentId : mixed
$registryType : string = SaleRegistry::REGISTRY_TYPE_ORDER
Tags
throws
ArgumentException
throws
ArgumentTypeException
Return values
array<string|int, mixed>

getSalesCheckList()

public static getSalesCheckList() : mixed

isAvailableCorrection()

public static isAvailableCorrection() : bool
Return values
bool

reprint()

public static reprint(int $checkId) : Result
Parameters
$checkId : int
Return values
Result

savePrintResult()

public static savePrintResult(mixed $checkId, array<string|int, mixed> $data) : Result
Parameters
$checkId : mixed
$data : array<string|int, mixed>
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
NotImplementedException
throws
ObjectException
throws
Exception
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results