Bitrix API

Invoice extends Base

Table of Contents

Constants

CALCULATED_FIELD_VALUE  = 1
LIMITED_BY_DATE  = 'D'
LIMITED_BY_TIMES  = 'T'
NO_LIMITED  = 'N'
SET_DATE_PAY_BEFORE  = 1
SETTED_FIELD_VALUE  = 0
UNSET_DATE_PAY_BEFORE  = 0

Methods

__construct()  : mixed
activate()  : UpdateResult|Result
Activate recurring invoices
add()  : Result
cancel()  : mixed
createEntity()  : Result
Create recurring invoice
deactivate()  : Result
delete()  : Result
expose()  : Result
Create new invoices from recurring invoices. Invoices's selection is from InvoiceRecurTable.
getInstance()  : mixed
getList()  : mixed
getNextDate()  : Date
Calculate next exposing date.
getParameterMapper()  : Map
getRuntimeTemplateField()  : array<string|int, mixed>
isAllowedExpose()  : bool
sendByMail()  : Result
update()  : Result
Update recurring invoice

Constants

CALCULATED_FIELD_VALUE

public mixed CALCULATED_FIELD_VALUE = 1

LIMITED_BY_DATE

public mixed LIMITED_BY_DATE = 'D'

LIMITED_BY_TIMES

public mixed LIMITED_BY_TIMES = 'T'

NO_LIMITED

public mixed NO_LIMITED = 'N'

SET_DATE_PAY_BEFORE

public mixed SET_DATE_PAY_BEFORE = 1

SETTED_FIELD_VALUE

public mixed SETTED_FIELD_VALUE = 0

UNSET_DATE_PAY_BEFORE

public mixed UNSET_DATE_PAY_BEFORE = 0

Methods

__construct()

public __construct() : mixed

activate()

Activate recurring invoices

public activate(mixed $primary) : UpdateResult|Result
Parameters
$primary : mixed
Tags
throws
Exception
Return values
UpdateResult|Result

add()

public add(array<string|int, mixed> $fields) : Result
Parameters
$fields : array<string|int, mixed>
Tags
throws
ObjectException
Return values
Result

cancel()

public cancel(mixed $primary[, string $reason = "" ]) : mixed
Parameters
$primary : mixed
$reason : string = ""
Tags
throws
Exception

createEntity()

Create recurring invoice

public createEntity(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()

public deactivate(mixed $primary) : Result
Parameters
$primary : mixed
Tags
throws
Exception
Return values
Result

delete()

public delete(mixed $primary) : Result
Parameters
$primary : mixed
Tags
throws
Exception
Return values
Result

expose()

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

public expose(array<string|int, mixed> $filter[, null $limit = null ][, bool $recalculate = true ]) : Result
Parameters
$filter : array<string|int, mixed>
$limit : null = null
$recalculate : bool = true
Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
Result

getInstance()

public static getInstance() : mixed

getList()

public getList([array<string|int, mixed> $parameters = array() ]) : mixed
Parameters
$parameters : array<string|int, mixed> = array()

getNextDate()

Calculate next exposing date.

public static getNextDate(array<string|int, mixed> $params[, null $startDate = null ]) : Date
Parameters
$params : array<string|int, mixed>
$startDate : null = null
Return values
Date

getParameterMapper()

public static getParameterMapper([array<string|int, mixed> $params = [] ]) : Map
Parameters
$params : array<string|int, mixed> = []
Return values
Map

getRuntimeTemplateField()

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

isAllowedExpose()

public isAllowedExpose() : bool
Return values
bool

sendByMail()

public sendByMail(mixed $emailList, mixed $emailData) : Result
Parameters
$emailList : mixed
$emailData : mixed
Return values
Result

update()

Update recurring invoice

public update(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