Documentation

Invoice
in package

Salesman

Класс для управления счетами

Class Invoice

Tags

author

Vladislav Andreev v@salesman.pro

version

1.0

(06/09/2019)

Example

$Invoice  = new Salesman\Invoice();
$result = $Invoice -> add($did, $params);
$response['result']  = 'Успешно';
$response['data']    = $crid;
$response['invoice'] = $arg['invoice'];
$response['text']    = $mes;

TIPS = ["ispeka" => "По спецификации", "ioffer" => "Счет-договор", "icontract" => "По договору", "ipre" => "Предварительная оплата", "iafter" => "Окончательная оплата"]: синонимы для типов счетов, можно передавать в любом виде
$db : mixed: Различные параметры, в основном из GLOBALS
$fpath : mixed: Различные параметры, в основном из GLOBALS
$identity : mixed: Различные параметры, в основном из GLOBALS
$iduser1 : mixed: Различные параметры, в основном из GLOBALS
$ivc : mixed: Различные параметры, в основном из GLOBALS
$opts : mixed: Различные параметры, в основном из GLOBALS
$otherSettings : array<string|int, mixed>
$params : array<string|int, mixed>: Передача различных параметров
$skey : mixed: Различные параметры, в основном из GLOBALS
$sqlname : mixed: Различные параметры, в основном из GLOBALS
$tmzone : mixed: Различные параметры, в основном из GLOBALS
$rootpath : false|string
__construct() : mixed
add() : array<string|int, mixed>: Добавление счета Также: - смена периода - смена этапа сделки
card() : array<string|int, mixed>: Данные для вывода счетов в картчоку сделки
delete() : array<string|int, mixed>: Удаление счета
doit() : array<string|int, mixed>: Отметка оплаты счета Также: - смена периода - смена этапа сделки
edit() : array<string|int, mixed>: Редактирование счета
express() : array<string|int, mixed>: Экспресс внесение оплаты Создается счет и проводится одновременно ??? Не доступно для сервисных сделок через форму
getCreditData() : array<string|int, mixed>: Возвращает массив выставленных счетов по сделке
getInvoice() : array<string|int, mixed>|bool: Подготовка счета для печати или в виде PDF
getQR() : string: Генерация QR-кода в виде строки
getTemplates() : array<string|int, mixed>: Выдает массив данных по шаблонам счетов
info() : array<string|int, mixed>: Информация по счету
link() : array<string|int, mixed>: Генерация PDF и предоставление ссылки на файл счета
list() : array<string|int, mixed>: Вывод списка счетов
mail() : array<string|int, mixed>: Отправка счета по email
undoit() : array<string|int, mixed>: Отмена проведения счета

TIPS

синонимы для типов счетов, можно передавать в любом виде


    public
        mixed
    TIPS
    = ["ispeka" => "По спецификации", "ioffer" => "Счет-договор", "icontract" => "По договору", "ipre" => "Предварительная оплата", "iafter" => "Окончательная оплата"]

$db

Различные параметры, в основном из GLOBALS


    public
        mixed
    $db

$fpath

Различные параметры, в основном из GLOBALS


    public
        mixed
    $fpath

$identity

Различные параметры, в основном из GLOBALS


    public
        mixed
    $identity

$iduser1

Различные параметры, в основном из GLOBALS


    public
        mixed
    $iduser1

$ivc

Различные параметры, в основном из GLOBALS


    public
        mixed
    $ivc

$opts

Различные параметры, в основном из GLOBALS


    public
        mixed
    $opts

$otherSettings


    public
        array<string|int, mixed>
    $otherSettings

$params

Передача различных параметров


    public
        array<string|int, mixed>
    $params
     = []

$skey

Различные параметры, в основном из GLOBALS


    public
        mixed
    $skey

$sqlname

Различные параметры, в основном из GLOBALS


    public
        mixed
    $sqlname

$tmzone

Различные параметры, в основном из GLOBALS


    public
        mixed
    $tmzone

$rootpath


    private
        false|string
    $rootpath

__construct()


    public
                    __construct() : mixed

Return values

mixed —

add()

Добавление счета Также: - смена периода - смена этапа сделки


    public
                    add(int $did[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$did : int

id сделки

$params : array<string|int, mixed> = []

массив с параметрами
invoice: номер счета, если не нужен автогенератор
igen: если номер счета надо сгенерировать (yes|no)
date date, datum: дата счета
date date_plan, datum_credit: плановая дата оплаты
float summa, summa_credit: сумма счета
contract, invoice_chek: номер договора
??? date_do, invoice_date: дата фактической оплаты
??? do: признак оплаты (on|no) - не нужен. !!! нужет только при оплате
rs: id расчетного счета
signer: id подписанта
tip: тип счета
ispeka, По спецификации
ioffer, Счет-договор
icontract, По договору
ipre, Предварительная оплата
iafter, Окончательная оплата
user, iduser: id ответственного по счету
suffix: текстовая часть счета
nds, nds_credit: сумма НДС по счету для сервисных сделок:
changePeriod: изменять ли период (yes|no)
dstart: начало периода
dend: конец периода для смены этапа сделки:
newstep: id нового этапа

Return values

array<string|int, mixed> —

card()

Данные для вывода счетов в картчоку сделки


    public
                    card(int $did) : array<string|int, mixed>

Parameters

$did : int

Return values

array<string|int, mixed> —

delete()

Удаление счета


    public
                    delete(int $crid[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$crid : int
$params : array<string|int, mixed> = []

Return values

array<string|int, mixed> —

doit()

Отметка оплаты счета Также: - смена периода - смена этапа сделки


    public
                    doit(int $crid[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$crid : int

$params : array<string|int, mixed> = []

массив с параметрами
invoice: номер счета, если не нужен автогенератор
summa, payment_now: сумма счета
date_do, invoice_date: дата фактической оплаты
do: признак оплаты (on|no) - не нужен. !!! нужет только при оплате
rs: id расчетного счета
user, iduser: id ответственного по счету
createDelta: требуется ли создавать счет, если оплата не полная (yes|no) для сервисных сделок:
changePeriod: изменять ли период (yes|no)
dstart: начало периода
dend: конец периода для смены этапа сделки:
newstep: id нового этапа

Return values

array<string|int, mixed> —

edit()

Редактирование счета


    public
                    edit(int $crid[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$crid : int

$params : array<string|int, mixed> = []

массив с параметрами
did: id сделки
invoice: номер счета, если не нужен автогенератор
date, datum: дата счета
date_plan, datum_credit: плановая дата оплаты
summa, summa_credit: сумма счета
contract, invoice_chek: номер договора
rs: id расчетного счета
signer: id подписанта
tip: тип счета
ispeka, По спецификации
ioffer, Счет-договор
icontract, По договору
ipre, Предварительная оплата
iafter, Окончательная оплата
user, iduser: id ответственного по счету
suffix: текстовая часть счета
nds, nds_credit: сумма НДС по счету

Return values

array<string|int, mixed> —

express()

Экспресс внесение оплаты Создается счет и проводится одновременно ??? Не доступно для сервисных сделок через форму


    public
                    express(int $did[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$did : int

$params : array<string|int, mixed> = []

массив с параметрами
invoice: номер счета, если не нужен автогенератор
igen: если номер счета надо сгенерировать (yes|no)
date, datum: дата счета
date_plan, datum_credit: плановая дата оплаты
summa, summa_credit: сумма счета
contract, invoice_chek: номер договора
date_do, invoice_date: дата фактической оплаты
??? do: признак оплаты (on|no) - не нужен. !!! нужет только при оплате
rs: id расчетного счета
signer: id подписанта
tip: тип счета
ispeka, По спецификации
ioffer, Счет-договор
icontract, По договору
ipre, Предварительная оплата
iafter, Окончательная оплата
user, iduser: id ответственного по счету
suffix: текстовая часть счета
nds, nds_credit: сумма НДС по счету
createDelta: требуется ли создавать счет, если оплата не полная (yes|no) для сервисных сделок:
changePeriod: изменять ли период (yes|no)
dstart: начало периода
dend: конец периода для смены этапа сделки:
newstep: id нового этапа

Return values

array<string|int, mixed> —

getCreditData()

Возвращает массив выставленных счетов по сделке


    public
                    getCreditData( $did) : array<string|int, mixed>

Parameters

$did :

Return values

array<string|int, mixed> —

getInvoice()

Подготовка счета для печати или в виде PDF


    public
                    getInvoice(int $crid[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|bool

Parameters

$crid : int

$params : array<string|int, mixed> = []

массив с параметрами
- tip: действие, def = tags (tags - вывод тэгов, print - вывод на печать, pdf - преобразование в pdf)
- download: если tip = pdf, то yes - выдача на скачивание, no - выдача в праузер, link - ссылка на файл, content - содержимое файла для записи
- tagsAttached: дополнение тегов:

$params = [
     "tagsAttached" => [
         "images" => [
             "barCode" => ["file" => "path/to/file/barcode423424.png", "tag" => "barCode",
             "photo"   => ["file" => "path/to/file/photo4656646.png", "tag" => "barCode"
         ],
         "ticket" => "0004556",
         "someTag" => "Это произвольный тег"
     ]
];

Return values

array<string|int, mixed>|bool —

getQR()

Генерация QR-кода в виде строки


    public
            static        getQR(array<string|int, mixed> $tags) : string

Parameters

$tags : array<string|int, mixed>

compUrName, compBankRs, compBankName, compBankBik, compBankKs, compInn, compKpp InvoiceSumma, Invoice, InvoiceDate, nalogName, nalogSumma

Return values

string —

getTemplates()

Выдает массив данных по шаблонам счетов


    public
            static        getTemplates([null $id = NULL ][, null $file = NULL ]) : array<string|int, mixed>

Parameters

$id : null = NULL

id шаблона

$file : null = NULL

файл шаблона
если не указаны, то в ответе приходит массив по всем шаблонам
если указан только id или file, то возвращается информация по конкретному шаблону
все данные возвращаются в подмассивах

Return values

array<string|int, mixed> —

ответ
id - id записи
title - название
file - файл
typeid - id типа документа

info()

Информация по счету


    public
            static        info( $crid[, bool $dealinclude = false ]) : array<string|int, mixed>

Parameters

$crid :
$dealinclude : bool = false

Return values

array<string|int, mixed> —

link()

Генерация PDF и предоставление ссылки на файл счета


    public
                    link(int $crid) : array<string|int, mixed>

Parameters

$crid : int

Return values

array<string|int, mixed> —

list()

Вывод списка счетов


    public
                    list([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []

page - страница
ord - сортировка
tuda - направление сортировки (desc||asc)
iduser
mc - id компании
bool pay[on] - только оплаченные
bool pay[off] - только не оплаченные
word - строка поиска

Return values

array<string|int, mixed> —

mail()

Отправка счета по email


    public
                    mail(int $crid[, array<string|int, mixed> $params = [] ][, bool $auto = false ]) : array<string|int, mixed>

Parameters

$crid : int

$params : array<string|int, mixed> = []

массив с параметрами - did: id сделки (не обязательно) - email: Массив email должен иметь формат массива = ['clid:32333','pid:3455','pid:555'] (не обязательно) - emails: Массив с указанием адресатов [["name" => "Name1","email" => "Email1"],["name" => "Name2","email" => "Email2"]] - clid: id клиента, если не задан параметр email и emails - pid: id контакта, если не задан параметр email и emails
theme: Тема сообщения
content: Содержание сообщения

$auto : bool = false

: параметр разрешает автоматически находить адресатов при отсутствии массива email

Return values

array<string|int, mixed> —

undoit()

Отмена проведения счета


    public
                    undoit(int $crid[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$crid : int

$params : array<string|int, mixed> = []

массив с параметрами
user, iduser: id ответственного за действие

Return values

array<string|int, mixed> —

Invoice in package Salesman

Tags

Table of Contents

Constants

TIPS

Properties

$db

$fpath

$identity

$iduser1

$ivc

$opts

$otherSettings

$params

$skey

$sqlname

$tmzone

$rootpath

Methods

__construct()

Return values

add()

Parameters

Tags

Return values

card()

Parameters

Tags

Return values

delete()

Parameters

Tags

Return values

doit()

Parameters

Tags

Return values

edit()

Parameters

Tags

Return values

express()

Parameters

Tags

Return values

getCreditData()

Parameters

Tags

Return values

getInvoice()

Parameters

Tags

Return values

getQR()

Parameters

Return values

getTemplates()

Parameters

Return values

info()

Parameters

Return values

link()

Parameters

Tags

Return values

list()

Parameters

Tags

Return values

mail()

Parameters

Tags

Return values

undoit()

Parameters

Tags

Return values

Invoice
in package

Salesman