Documentation

ParovacFaktur extends Sand
in package

Invoice matching class

Tags
copyright

(c) 2018-2023, Vítězslav Dvořák

author

Vítězslav Dvořák info@vitexsoftware.cz

Table of Contents

$banker  : Banka
account statements handler object
$cfgRequed  : array<string|int, mixed>
Requied Config Keys
$daysBack  : Od
$defaultHttpHeaders  : array<string|int, mixed>
$config  : array<string|int, mixed>
Configuration options
$docTypes  : type
$invoicer  : FakturaVydana|FakturaPrijata
Invoice handler object
__construct()  : mixed
Invoice matcher
apiUrlToLink()  : string
Change url to html link
assignBankAccountToAddress()  : bool
Assign Bank Account to Address
findBestPayment()  : Banka
Najde nejlepší platbu pro danou fakturu
findInvoice()  : array<string|int, mixed>
Vrací neuhrazene faktury odpovídající zadaným parametrům
findInvoices()  : array<string|int, mixed>
Najde vydané faktury
findPayment()  : array<string|int, mixed>
Vrací nesparovane platby odpovídající zadaným parametrům
findPayments()  : array<string|int, mixed>
Najde příchozí platby
getCompanyForBUC()  : string
Obtain AbraFlexi company code for given bank account number
getDocumentTypes()  : mixed
getInvoicer()  : FakturaVydana
Prepare invoice helper
getInvoicesToProcess()  : array<string|int, mixed>
Vrací neuhrazené faktury
getOriginDocumentType()  : string
Return Document original type
getPaymentsToProcess()  : array<string|int, mixed>
Get unmatched payments within given days and direction
getPaymentsWithinPeriod()  : array<string|int, mixed>
hotfixDeductionOfAdvances()  : type
inInvoicesMatchingByBank()  : mixed
Párování prichozich faktur podle odchozich plateb v bance
invoiceCopy()  : FakturaVydana
Provizorní zkopírování faktury
invoicesMatchingByInvoices()  : mixed
Párování faktur dle nezaplacenych faktur
isKnownBankAccountForAddress()  : bool
isSameAccount()  : bool
Check for common bank account
isSameCompany()  : bool
Check for common company
outInvoiceMatchByBank()  : type
Match Invoice with Payment
outInvoicesMatchingByBank()  : mixed
Párování odchozích faktur podle příchozích plateb v bance
paymentToZDD()  : mixed
reindexInvoicesByDate()  : array<string|int, mixed>
Reindex array of Invoice Data by datVyst or another column with date
reorderInvoicesByAge()  : array<string|int, mixed>
Reorder invoices by Age.
savePayerAccount()  : bool
Assign Bank Account to Address
searchInvoices()  : array<string|int, mixed>
Vrací neuhrazene faktury odpovídající zadaným parametrům
setStartDay()  : mixed
Start set date
settleCreditNote()  : int
Provede "Zaplacení" vydaného dobropisu
settleInvoice()  : int
Provede "Zaplacení" vydané faktury
settleProforma()  : int
Provede "Zaplacení" vydané zalohove faktury
unifyInvoices()  : mixed
vytvorVazbuZDD()  : mixed

Properties

$banker

account statements handler object

public Banka $banker

$cfgRequed

Requied Config Keys

public array<string|int, mixed> $cfgRequed = ["LABEL_OVERPAY", "LABEL_INVOICE_MISSING", "LABEL_UNIDENTIFIED"]

$daysBack

public Od $daysBack = 1

kdy začít dohledávat doklady

$defaultHttpHeaders

public array<string|int, mixed> $defaultHttpHeaders

$config

Configuration options

private array<string|int, mixed> $config = ['limit' => 0]

$invoicer

Invoice handler object

private FakturaVydana|FakturaPrijata $invoicer

Methods

__construct()

Invoice matcher

public __construct([mixed $configuration = [] ]) : mixed
Parameters
$configuration : mixed = []
Return values
mixed

Change url to html link

public static apiUrlToLink(string $apiURL) : string
Parameters
$apiURL : string
Return values
string

assignBankAccountToAddress()

Assign Bank Account to Address

public static assignBankAccountToAddress(Adresar|string $address, Banka $payment) : bool
Parameters
$address : Adresar|string

Object or code: identier

$payment : Banka
Return values
bool

added ?

findBestPayment()

Najde nejlepší platbu pro danou fakturu

public findBestPayment(array<string|int, mixed> $payments, FakturaVydana $invoice) : Banka
Parameters
$payments : array<string|int, mixed>

pole příchozích plateb

$invoice : FakturaVydana

faktura ke spárování

Return values
Banka

Bankovní pohyb

findInvoice()

Vrací neuhrazene faktury odpovídající zadaným parametrům

public findInvoice(array<string|int, mixed> $what) : array<string|int, mixed>
Parameters
$what : array<string|int, mixed>
Return values
array<string|int, mixed>

findInvoices()

Najde vydané faktury

public findInvoices(array<string|int, mixed> $paymentData) : array<string|int, mixed>
Parameters
$paymentData : array<string|int, mixed>
Return values
array<string|int, mixed>

findPayment()

Vrací nesparovane platby odpovídající zadaným parametrům

public findPayment(array<string|int, mixed> $what) : array<string|int, mixed>
Parameters
$what : array<string|int, mixed>
Return values
array<string|int, mixed>

findPayments()

Najde příchozí platby

public findPayments(array<string|int, mixed> $invoiceData) : array<string|int, mixed>
Parameters
$invoiceData : array<string|int, mixed>
Return values
array<string|int, mixed>

getCompanyForBUC()

Obtain AbraFlexi company code for given bank account number

public getCompanyForBUC(string $account[, string $bankCode = null ]) : string
Parameters
$account : string
$bankCode : string = null
Return values
string

Company Code

getDocumentTypes()

public getDocumentTypes() : mixed
Return values
mixed

getInvoicer()

Prepare invoice helper

public getInvoicer() : FakturaVydana
Return values
FakturaVydana

getInvoicesToProcess()

Vrací neuhrazené faktury

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

getOriginDocumentType()

Return Document original type

public getOriginDocumentType(string $typDokl) : string
Parameters
$typDokl : string
Return values
string

typDokladu.faktura|typDokladu.dobropis| typDokladu.zalohFaktura|typDokladu.zdd| typDokladu.dodList|typDokladu.proforma| typBanUctu.kc|typBanUctu.mena

getPaymentsToProcess()

Get unmatched payments within given days and direction

public getPaymentsToProcess([int $daysBack = 1 ][, string $direction = 'in' ]) : array<string|int, mixed>
Parameters
$daysBack : int = 1

Maximum age of payment

$direction : string = 'in'

Incoming or outcoming payents in|out

Return values
array<string|int, mixed>

getPaymentsWithinPeriod()

public getPaymentsWithinPeriod(DatePeriod $period[, string $direction = 'in' ]) : array<string|int, mixed>
Parameters
$period : DatePeriod
$direction : string = 'in'
Return values
array<string|int, mixed>

hotfixDeductionOfAdvances()

public hotfixDeductionOfAdvances(FakturaVydana $invoice, Banka $payment) : type
Parameters
$invoice : FakturaVydana

ZDD

$payment : Banka

Income

Return values
type

inInvoicesMatchingByBank()

Párování prichozich faktur podle odchozich plateb v bance

public inInvoicesMatchingByBank([DatePeriod $range = null ]) : mixed
Parameters
$range : DatePeriod = null
Return values
mixed

invoiceCopy()

Provizorní zkopírování faktury

public invoiceCopy(FakturaVydana $invoice[, array<string|int, mixed> $extraValues = [] ]) : FakturaVydana
Parameters
$invoice : FakturaVydana
$extraValues : array<string|int, mixed> = []

Extra hodnoty pro kopii faktury

Tags
link

Chyba při Provádění akcí přes REST API JSON

Return values
FakturaVydana

invoicesMatchingByInvoices()

Párování faktur dle nezaplacenych faktur

public invoicesMatchingByInvoices() : mixed
Return values
mixed

isKnownBankAccountForAddress()

public static isKnownBankAccountForAddress(Adresar $address, string $buc) : bool
Parameters
$address : Adresar
$buc : string
Return values
bool

isSameAccount()

Check for common bank account

public static isSameAccount(array<string|int, mixed> $documents) : bool
Parameters
$documents : array<string|int, mixed>

invoices or payments data

Return values
bool

All records have same bank account

isSameCompany()

Check for common company

public static isSameCompany(array<string|int, mixed> $documents) : bool
Parameters
$documents : array<string|int, mixed>

invoices or payments data

Return values
bool

All records have same company

outInvoiceMatchByBank()

Match Invoice with Payment

public outInvoiceMatchByBank(mixed $invoiceData, type $payment) : type
Parameters
$invoiceData : mixed
$payment : type
Return values
type

outInvoicesMatchingByBank()

Párování odchozích faktur podle příchozích plateb v bance

public outInvoicesMatchingByBank() : mixed
Return values
mixed

paymentToZDD()

public paymentToZDD(mixed $invoiceData) : mixed
Parameters
$invoiceData : mixed
Return values
mixed

reindexInvoicesByDate()

Reindex array of Invoice Data by datVyst or another column with date

public static reindexInvoicesByDate(array<string|int, mixed> $invoices[, mixed $sortBy = 'datVyst' ]) : array<string|int, mixed>
Parameters
$invoices : array<string|int, mixed>
$sortBy : mixed = 'datVyst'
Return values
array<string|int, mixed>

reorderInvoicesByAge()

Reorder invoices by Age.

public static reorderInvoicesByAge(array<string|int, mixed> $invoices) : array<string|int, mixed>
Parameters
$invoices : array<string|int, mixed>
Return values
array<string|int, mixed>

Older First sorted invoices

savePayerAccount()

Assign Bank Account to Address

public savePayerAccount(Adresar|string $payer, Banka $payment) : bool
Parameters
$payer : Adresar|string

Object or code: identier

$payment : Banka

Payment object

Return values
bool

account was assigned to Address

searchInvoices()

Vrací neuhrazene faktury odpovídající zadaným parametrům

public searchInvoices(array<string|int, mixed> $what) : array<string|int, mixed>
Parameters
$what : array<string|int, mixed>
Return values
array<string|int, mixed>

setStartDay()

Start set date

public setStartDay(int $daysBack) : mixed
Parameters
$daysBack : int
Return values
mixed

settleCreditNote()

Provede "Zaplacení" vydaného dobropisu

public settleCreditNote(FakturaVydana $invoice, Banka $payment) : int
Parameters
$invoice : FakturaVydana
$payment : Banka
Return values
int

vysledek 0 = chyba, 1 = sparovano

settleInvoice()

Provede "Zaplacení" vydané faktury

public settleInvoice(FakturaVydana $invoice, Banka $payment) : int
Parameters
$invoice : FakturaVydana

Invoice to settle

$payment : Banka

Payment to settle by

Return values
int

vysledek 0 = chyba, 1 = sparovano

settleProforma()

Provede "Zaplacení" vydané zalohove faktury

public settleProforma(FakturaVydana $zaloha, array<string|int, mixed> $payment) : int
Parameters
$zaloha : FakturaVydana
$payment : array<string|int, mixed>
Return values
int

vysledek 0 = chyba, 1 = sparovano, 2 sparovano a vytvorena faktura, -1 sparovnano ale chyba vytvoreni faktury

unifyInvoices()

public static unifyInvoices(array<string|int, mixed> $vInvoices, array<string|int, mixed> &$invoices) : mixed
Parameters
$vInvoices : array<string|int, mixed>

new invoices

$invoices : array<string|int, mixed>

current invoices

Return values
mixed

vytvorVazbuZDD()

public vytvorVazbuZDD(array<string|int, mixed> $paymentData, int $invoiceId) : mixed
Parameters
$paymentData : array<string|int, mixed>
$invoiceId : int
Return values
mixed

Search results