Bitrix API

Manager

Table of Contents

Constants

DEAL  = 'Deal'
INVOICE  = 'Invoice'
MULTIPLY_EXECUTION  = 2
MULTIPLY_EXECUTION_NAME  = 'multiple'
SINGLE_EXECUTION  = 1
SINGLE_EXECUTION_NAME  = 'single'

Methods

activate()  : Result
Activate recurring entity
cancel()  : Result
checkAgent()  : string
Control of exposing agent.
createEntity()  : Result
Create a new recurring entity.
createInvoice()  : Result
Create recurring invoice
deactivate()  : Result
Deactivate recurring entity
expose()  : Result
Creating new entities by recurring template entities. Filter is used for filtering from {EntityType}RecurTable
exposeAgent()  : string
Create new entities in agent. By default limit of exposing is 10 entities by hit.
exposeInvoices()  : Result
Create new invoices from recurring invoices. Invoices's selection is from InvoiceRecurTable.
exposeToday()  : Result
exposeTodayInvoices()  : Result
getList()  : Result
initCheckAgent()  : string
Start controlling agent.
isActiveExecutionDate()  : bool
Check date of next invoicing by params.
isAllowedExpose()  : bool
Check an ability of new entities creation.
update()  : Result
Update a recurring entity.
updateRecurring()  : Result
Update recurring invoice

Constants

INVOICE

public mixed INVOICE = 'Invoice'

MULTIPLY_EXECUTION

public mixed MULTIPLY_EXECUTION = 2

MULTIPLY_EXECUTION_NAME

public mixed MULTIPLY_EXECUTION_NAME = 'multiple'

SINGLE_EXECUTION

public mixed SINGLE_EXECUTION = 1

SINGLE_EXECUTION_NAME

public mixed SINGLE_EXECUTION_NAME = 'single'

Methods

activate()

Activate recurring entity

public static activate(mixed $entityId[, mixed $typeEntity = self::INVOICE ]) : Result
Parameters
$entityId : mixed
$typeEntity : mixed = self::INVOICE

. Entity type from class constants. Default is INVOICE for compatibility.

Tags
throws
ArgumentException
throws
Exception
Return values
Result

cancel()

public static cancel(mixed $entityId[, string $reason = "" ][, mixed $typeEntity = self::INVOICE ]) : Result
Parameters
$entityId : mixed
$reason : string = ""
$typeEntity : mixed = self::INVOICE

. Entity type. Default is INVOICE for compatibility.

Tags
throws
ArgumentException
throws
Exception
Return values
Result

checkAgent()

Control of exposing agent.

public static checkAgent() : string
Return values
string

createEntity()

Create a new recurring entity.

public static createEntity(mixed $entityFields, mixed $recurringParams[, mixed $typeEntity = self::INVOICE ]) : Result
Parameters
$entityFields : mixed
$recurringParams : mixed
$typeEntity : mixed = self::INVOICE
Return values
Result

createInvoice()

Create recurring invoice

public static createInvoice(array<string|int, mixed> $invoiceFields, array<string|int, mixed> $recurParams) : Result
Parameters
$invoiceFields : array<string|int, mixed>
$recurParams : array<string|int, mixed>
Tags
throws
Exception
Return values
Result

deactivate()

Deactivate recurring entity

public static deactivate(mixed $entityId[, mixed $typeEntity = self::INVOICE ]) : Result
Parameters
$entityId : mixed
$typeEntity : mixed = self::INVOICE

. Entity type from class constants. Default is INVOICE for compatibility

Tags
throws
ArgumentException
throws
Exception
Return values
Result

expose()

Creating new entities by recurring template entities. Filter is used for filtering from {EntityType}RecurTable

public static expose([mixed $filter = array() ][, mixed $limit = null ][, mixed $typeEntity = self::INVOICE ]) : Result
Parameters
$filter : mixed = array()
$limit : mixed = null
$typeEntity : mixed = self::INVOICE
Return values
Result

exposeAgent()

Create new entities in agent. By default limit of exposing is 10 entities by hit.

public static exposeAgent([mixed $typeEntity = self::INVOICE ]) : string
Parameters
$typeEntity : mixed = self::INVOICE

. Entity type from class constants. Default is INVOICE for compatibility.

Return values
string

exposeInvoices()

Create new invoices from recurring invoices. Invoices's selection is from InvoiceRecurTable.

public static exposeInvoices(mixed $filter[, mixed $limit = null ]) : Result
Parameters
$filter : mixed
$limit : mixed = null
Tags
throws
ArgumentException
Return values
Result

exposeToday()

public static exposeToday([mixed $limit = null ][, mixed $typeEntity = self::INVOICE ]) : Result
Parameters
$limit : mixed = null
$typeEntity : mixed = self::INVOICE

. Entity type from class constants. Default is INVOICE for compatibility.

Return values
Result

exposeTodayInvoices()

public static exposeTodayInvoices([mixed $limit = null ]) : Result
Parameters
$limit : mixed = null
Return values
Result

getList()

public static getList([mixed $params = array() ][, mixed $typeEntity = self::INVOICE ]) : Result
Parameters
$params : mixed = array()
$typeEntity : mixed = self::INVOICE

. Entity type. Default is INVOICE for compatibility.

Return values
Result

initCheckAgent()

Start controlling agent.

public static initCheckAgent([mixed $typeEntity = self::INVOICE ]) : string
Parameters
$typeEntity : mixed = self::INVOICE
Return values
string

isActiveExecutionDate()

Check date of next invoicing by params.

public static isActiveExecutionDate(mixed $params) : bool
Parameters
$params : mixed
Return values
bool

isAllowedExpose()

Check an ability of new entities creation.

public static isAllowedExpose(mixed $typeEntity) : bool
Parameters
$typeEntity : mixed
Return values
bool

update()

Update a recurring entity.

public static update(mixed $primary, mixed $data[, mixed $typeEntity = self::INVOICE ]) : Result
Parameters
$primary : mixed
$data : mixed
$typeEntity : mixed = self::INVOICE
Return values
Result

updateRecurring()

Update recurring invoice

public static updateRecurring(int $primary, array<string|int, mixed> $data) : Result
Parameters
$primary : int
$data : array<string|int, mixed>
Tags
throws
Exception
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results