CoolCMS API

Invoice extends BaseEntity
in package

Application

implements IdentifiableInterface uses IdentifiableTrait, TaxSnapshotTrait, ItemCollectionTrait, GiftCollectionTrait, VoucherCollectionTrait, ShipperCollectionTrait, PaymentMethodCollectionTrait

AbstractYes

Interfaces

IdentifiableInterface: Entity with a simple integer primary key. Most entities have one (often via {@see \App\Core\Traits\Shared\Models\Entities\IdentifiableTrait}); texts and links with a composite key do not, which is why `getId()` is not on {@see \App\Core\Base\BaseEntity}. Code that needs the id of a generic entity asks for this interface (parameter type, template bound, `instanceof`).

Constants

LOCK_REASON_CREDIT_NOTE : string = 'creditNote': Invoice lock reason: a credit note or cancellation was issued against it (changing the source would break the cap ledger).
LOCK_REASON_EMAIL : string = 'email': Invoice lock reason: sent to the customer by e-mail.
LOCK_REASON_MANUAL : string = 'manual': Invoice lock reason: explicitly locked by an administrator (e.g. invoice handed over outside the system).

Properties

$bankAccount : string|null
$bankName : string|null
$billingLineId : int|null
$constantSymbol : string|null
$creationDate : DateTime
$currencyId : int|null
$customerCity : string|null
$customerContactId : int|null
$customerContactId2 : int|null
$customerCountry : string|null
$customerCountryCode : string|null
$customerDlvCity : string|null
$customerDlvCountry : string|null
$customerDlvCountryCode : string|null
$customerDlvInformations : string|null
$customerDlvName : string|null
$customerDlvName2 : string|null
$customerDlvPostcode : string|null
$customerDlvStreet : string|null
$customerEmail : string|null
$customerId : int|null
$customerId2 : int|null
$customerInformations : string|null
$customerName : string|null
$customerName2 : string|null
$customerPhone : string|null
$customerPostcode : string|null
$customerRegNo : string|null
$customerStreet : string|null
$customerVatId : string|null
$customerVatIdCheckId : int|null: Applied VAT id check (`cms_system_vat_id_checks`): consultation number or manual proof.
$customerVatIdOutageCheckId : int|null: Record of a VIES outage on the supply date.
$customerVatIdVerified : bool|null: Null means the VAT id does not matter (empty or domestic); false is unverified; true is verified.
$customerVatIdVerifiedAt : DateTime|null
$customerVatInformations : string|null
$dueDate : DateTime|null
$emailBody : string|null
$emailIsSent : bool
$emailSubject : string|null
$emailTo : string|null
$gifts : Collection<int, TGift>
$iban : string|null
$id : int|null
$informations : string|null
$insertDatetime : DateTime
$invoiceTemplateId : int|null
$invoiceTypeId : int|null
$items : Collection<int, TItem>
$languageId : int|null
$localization : object|null: Localization the document is formatted by (separators, decimals, suffix). Snapshot at issue time: a document must never be formatted by the current request, otherwise a regenerated PDF would differ from the original. Inherited from the order, otherwise from the invoice template. Null (historical documents) falls back to the currency.
$lockedDatetime : DateTime|null
$lockReason : string|null
$number : string|null
$order : int
$orderId : int|null
$paymentId : int|null
$paymentMethodId : int|null
$paymentMethods : Collection<int, TPaymentMethod>
$paymentRegionId : int|null
$pdf : string|null
$pdfTemplateId : int|null
$pdfTemplateVariantId : int|null
$periodKey : string
$productTypeId : int|null
$qrCode : string|null
$relatedInvoiceId : int|null
$roundedTotalPrice : string|null
$roundedTotalPriceWithVat : string|null
$rounding : string|null
$roundingWithVat : string|null
$sellerBankAccountId : int|null
$sellerCity : string|null
$sellerContactId : int|null
$sellerCountry : string|null
$sellerEmail : string|null
$sellerId : int|null
$sellerInformations : string|null
$sellerName : string|null
$sellerName2 : string|null
$sellerPhone : string|null
$sellerPostcode : string|null
$sellerRegNo : string|null
$sellerStreet : string|null
$sellerVatId : string|null
$sellerVatInformations : string|null
$sendEmail : bool
$shippers : Collection<int, TShipper>
$signature : string|null
$specificSymbol : string|null
$status : string
$summaryReportCode : string|null: Supply code for the summary report (`3` services, `0` goods); null means it is not reported.
$swift : string|null
$taxableSupplyDate : DateTime|null
$taxCountryCode : string|null: Country of the applied rate (null without VAT).
$taxDate : DateTime|null: Date of the rate and of the seller status.
$taxFlags : array<int, string>|null
$taxNote : string|null: Note in the document language (plus Czech), resolved at creation.
$taxOverrideReason : string|null
$taxTreatment : string|null: Treatment code; on a payment also the markers `INTERMEDIARY` and `CREDIT_REDEMPTION`.
$totalPrice : string|null
$totalPriceWithVat : string|null
$useDeliveryAddress : bool
$userTypeId : int|null
$useVat : bool
$variableSymbol : string|null
$vouchers : Collection<int, TVoucher>

Methods

__construct() : mixed
addGift() : $this
addItem() : $this
addPaymentMethod() : $this
addShipper() : $this
addVoucher() : $this
callInitMethods() : void: Calls `init{TraitName}()` for every used trait that defines such a method.
clearGifts() : $this
clearItems() : $this
clearPaymentMethods() : $this
clearShippers() : $this
clearVouchers() : $this
getAllTraits() : array<string, string>: Returns all traits the class uses, including those used by parent classes and nested traits.
getBankAccount() : string|null
getBankName() : string|null
getBillingLineId() : int|null
getConstantSymbol() : string|null
getCreationDate() : DateTime
getCurrencyId() : int|null
getCustomerCity() : string|null
getCustomerContactId() : int|null
getCustomerContactId2() : int|null
getCustomerCountry() : string|null
getCustomerCountryCode() : string|null
getCustomerDlvCity() : string|null
getCustomerDlvCountry() : string|null
getCustomerDlvCountryCode() : string|null
getCustomerDlvInformations() : string|null
getCustomerDlvName() : string|null
getCustomerDlvName2() : string|null
getCustomerDlvPostcode() : string|null
getCustomerDlvStreet() : string|null
getCustomerEmail() : string|null
getCustomerId() : int|null
getCustomerId2() : int|null
getCustomerInformations() : string|null
getCustomerName() : string|null
getCustomerName2() : string|null
getCustomerPhone() : string|null
getCustomerPostcode() : string|null
getCustomerRegNo() : string|null
getCustomerStreet() : string|null
getCustomerVatId() : string|null
getCustomerVatIdCheckId() : int|null
getCustomerVatIdOutageCheckId() : int|null
getCustomerVatIdVerified() : bool|null
getCustomerVatIdVerifiedAt() : DateTime|null
getCustomerVatInformations() : string|null
getDueDate() : DateTime|null
getEmailBody() : string|null
getEmailIsSent() : bool
getEmailSubject() : string|null
getEmailTo() : string|null
getGift() : TGift|null
getGifts() : Collection<int, TGift>
getIban() : string|null
getId() : int|null
getInformations() : string|null
getInsertDatetime() : DateTime
getInvoiceTemplateId() : int|null
getInvoiceTypeId() : int|null
getItem() : TItem|null
getItems() : Collection<int, TItem>
getLanguageId() : int|null
getLocalization() : object|null
getLocalizationId() : int|null: The object wins over the scalar (a freshly set localization beats the mirror loaded from the DB), but `$localization` is an untyped `object`, hence the guard instead of a plain `?->getId()`. Without it PHPStan reports `object::getId()` and a foreign object in the association would fail at runtime.
getLockedDatetime() : DateTime|null
getLockReason() : string|null
getNumber() : string|null
getOrder() : int
getOrderId() : int|null
getPaymentId() : int|null
getPaymentMethodId() : int|null
getPaymentMethods() : Collection<int, TPaymentMethod>
getPaymentRegionId() : int|null
getPdf() : string|null
getPdfTemplateId() : int|null
getPdfTemplateVariantId() : int|null
getPeriodKey() : string
getProductTypeId() : int|null
getQrCode() : string|null
getRelatedInvoiceId() : int|null
getRoundedTotalPrice() : string|null
getRoundedTotalPriceWithVat() : string|null
getRounding() : string|null
getRoundingWithVat() : string|null
getSellerBankAccountId() : int|null
getSellerCity() : string|null
getSellerContactId() : int|null
getSellerCountry() : string|null
getSellerEmail() : string|null
getSellerId() : int|null
getSellerInformations() : string|null
getSellerName() : string|null
getSellerName2() : string|null
getSellerPhone() : string|null
getSellerPostcode() : string|null
getSellerRegNo() : string|null
getSellerStreet() : string|null
getSellerVatId() : string|null
getSellerVatInformations() : string|null
getSendEmail() : bool
getShippers() : Collection<int, TShipper>
getSignature() : string|null
getSpecificSymbol() : string|null
getStatus() : string
getSummaryReportCode() : string|null
getSwift() : string|null
getTaxableSupplyDate() : DateTime|null
getTaxCountryCode() : string|null
getTaxDate() : DateTime|null
getTaxFlags() : array<int, string>|null
getTaxNote() : string|null
getTaxOverrideReason() : string|null
getTaxTreatment() : string|null
getTotalPrice() : string|null
getTotalPriceWithVat() : string|null
getUseDeliveryAddress() : bool
getUserTypeId() : int|null
getUseVat() : bool
getVariableSymbol() : string|null
getVoucher() : TVoucher|null
getVouchers() : Collection<int, TVoucher>
giftCollectionInit() : void
hasTaxFlag() : bool
isEmailSent() : bool
isLocked() : bool: Locked invoice: amounts, lines and customer can no longer be changed; fix it with a credit note.
isPersisted() : bool
isSendEmail() : bool
isUseDeliveryAddress() : bool
isUseVat() : bool
itemCollectionInit() : void
paymentMethodCollectionInit() : void
removeGift() : $this
removeItem() : $this
removePaymentMethod() : $this
removeShipper() : $this
removeVoucher() : $this
setBankAccount() : $this
setBankName() : $this
setBillingLineId() : $this
setConstantSymbol() : $this
setCreationDate() : $this
setCurrencyId() : $this
setCustomerCity() : $this
setCustomerContactId() : $this
setCustomerContactId2() : $this
setCustomerCountry() : $this
setCustomerCountryCode() : $this
setCustomerDlvCity() : $this
setCustomerDlvCountry() : $this
setCustomerDlvCountryCode() : $this
setCustomerDlvInformations() : $this
setCustomerDlvName() : $this
setCustomerDlvName2() : $this
setCustomerDlvPostcode() : $this
setCustomerDlvStreet() : $this
setCustomerEmail() : $this
setCustomerId() : $this
setCustomerId2() : $this
setCustomerInformations() : $this
setCustomerName() : $this
setCustomerName2() : $this
setCustomerPhone() : $this
setCustomerPostcode() : $this
setCustomerRegNo() : $this
setCustomerStreet() : $this
setCustomerVatId() : $this
setCustomerVatIdCheckId() : static
setCustomerVatIdOutageCheckId() : static
setCustomerVatIdVerified() : static
setCustomerVatIdVerifiedAt() : static
setCustomerVatInformations() : $this
setDueDate() : $this
setEmailBody() : $this
setEmailIsSent() : $this
setEmailSubject() : $this
setEmailTo() : $this
setGifts() : $this
setIban() : $this
setId() : $this
setInformations() : $this
setInsertDatetime() : $this
setInvoiceTemplateId() : $this
setInvoiceTypeId() : $this
setItems() : $this
setLanguageId() : $this
setLocalization() : $this: IMPORTANT: deliberately without the side effect `$this->localizationId = $localization?->getId()`.
setLocalizationId() : $this: The FK mirror is set by the form together with the association: Api `resolveRelations()` fills a null association from the mirror (entity loaded without include), so clearing the localization must not carry the old mirror over. In the DB the column is written only through the association.
setLockedDatetime() : $this
setLockReason() : $this
setNumber() : $this
setOrder() : $this
setOrderId() : $this
setPaymentId() : $this
setPaymentMethodId() : $this
setPaymentMethods() : $this
setPaymentRegionId() : $this
setPdf() : $this
setPdfTemplateId() : $this
setPdfTemplateVariantId() : $this
setPeriodKey() : $this
setProductTypeId() : $this
setQrCode() : $this
setRelatedInvoiceId() : $this
setRoundedTotalPrice() : $this
setRoundedTotalPriceWithVat() : $this
setRounding() : $this
setRoundingWithVat() : $this
setSellerBankAccountId() : $this
setSellerCity() : $this
setSellerContactId() : $this
setSellerCountry() : $this
setSellerEmail() : $this
setSellerId() : $this
setSellerInformations() : $this
setSellerName() : $this
setSellerName2() : $this
setSellerPhone() : $this
setSellerPostcode() : $this
setSellerRegNo() : $this
setSellerStreet() : $this
setSellerVatId() : $this
setSellerVatInformations() : $this
setSendEmail() : $this
setShippers() : $this
setSignature() : $this
setSpecificSymbol() : $this
setStatus() : $this
setSummaryReportCode() : static
setSwift() : $this
setTaxableSupplyDate() : $this
setTaxCountryCode() : static
setTaxDate() : static
setTaxFlags() : static
setTaxNote() : static
setTaxOverrideReason() : $this
setTaxTreatment() : static
setTotalPrice() : $this
setTotalPriceWithVat() : $this
setUseDeliveryAddress() : $this
setUserTypeId() : $this
setUseVat() : $this
setVariableSymbol() : $this
setVouchers() : $this
shipperCollectionInit() : void
voucherCollectionInit() : void
getTraitsRecursive() : array<string, string>: Walks the trait list recursively and collects nested traits too.

LOCK_REASON_CREDIT_NOTE

Invoice lock reason: a credit note or cancellation was issued against it (changing the source would break the cap ledger).


    public
        string
    LOCK_REASON_CREDIT_NOTE
    = 'creditNote'

LOCK_REASON_EMAIL

Invoice lock reason: sent to the customer by e-mail.


    public
        string
    LOCK_REASON_EMAIL
    = 'email'

LOCK_REASON_MANUAL

Invoice lock reason: explicitly locked by an administrator (e.g. invoice handed over outside the system).


    public
        string
    LOCK_REASON_MANUAL
    = 'manual'

$bankAccount


        protected
            string|null
    $bankAccount
     = null

#[Column]: $name: 'bank_account'; $type: 'string'; $length: 50; $nullable: true

$bankName


        protected
            string|null
    $bankName
     = null

#[Column]: $name: 'bank_name'; $type: 'string'; $length: 255; $nullable: true

$billingLineId


        protected
            int|null
    $billingLineId
     = null

#[Column]: $name: 'cms_mod_invoicer_billing_lines_billing_line_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

#[ExternalReadonly]

$constantSymbol


        protected
            string|null
    $constantSymbol
     = null

#[Column]: $name: 'constant_symbol'; $type: 'string'; $length: 255; $nullable: true

$creationDate


        protected
            DateTime
    $creationDate
     = new DateTime()

#[Column]: $name: 'creation_date'; $type: 'date'

$currencyId


        protected
            int|null
    $currencyId
     = null

#[Column]: $name: 'cms_system_currencies_currency_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$customerCity


        protected
            string|null
    $customerCity
     = null

#[Column]: $name: 'customer_city'; $type: 'string'; $length: 255; $nullable: true

$customerContactId


        protected
            int|null
    $customerContactId
     = null

#[Column]: $name: 'cms_mod_invoicer_customer_contacts_customer_contact_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$customerContactId2


        protected
            int|null
    $customerContactId2
     = null

#[Column]: $name: 'cms_mod_invoicer_customer_contacts_customer_contact_id2'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$customerCountry


        protected
            string|null
    $customerCountry
     = null

#[Column]: $name: 'customer_country'; $type: 'string'; $length: 255; $nullable: true

$customerCountryCode


        protected
            string|null
    $customerCountryCode
     = null

#[Column]: $name: 'customer_country_code'; $type: 'string'; $length: 2; $nullable: true; $options: ['fixed' => true]

#[ExternalReadonly]

$customerDlvCity


        protected
            string|null
    $customerDlvCity
     = null

#[Column]: $name: 'customer_dlv_city'; $type: 'string'; $length: 255; $nullable: true

$customerDlvCountry


        protected
            string|null
    $customerDlvCountry
     = null

#[Column]: $name: 'customer_dlv_country'; $type: 'string'; $length: 255; $nullable: true

$customerDlvCountryCode


        protected
            string|null
    $customerDlvCountryCode
     = null

#[Column]: $name: 'customer_dlv_country_code'; $type: 'string'; $length: 2; $nullable: true; $options: ['fixed' => true]

#[ExternalReadonly]

$customerDlvInformations


        protected
            string|null
    $customerDlvInformations
     = null

#[Column]: $name: 'customer_dlv_informations'; $type: 'text'; $nullable: true

$customerDlvName


        protected
            string|null
    $customerDlvName
     = null

#[Column]: $name: 'customer_dlv_name'; $type: 'string'; $length: 255; $nullable: true

$customerDlvName2


        protected
            string|null
    $customerDlvName2
     = null

#[Column]: $name: 'customer_dlv_name_2'; $type: 'string'; $length: 255; $nullable: true

$customerDlvPostcode


        protected
            string|null
    $customerDlvPostcode
     = null

Attributes

#[Column]: $name: 'customer_dlv_postcode'; $type: 'string'; $length: 50; $nullable: true

$customerDlvStreet


        protected
            string|null
    $customerDlvStreet
     = null

#[Column]: $name: 'customer_dlv_street'; $type: 'string'; $length: 255; $nullable: true

$customerEmail


        protected
            string|null
    $customerEmail
     = null

#[Column]: $name: 'customer_email'; $type: 'string'; $length: 255; $nullable: true

$customerId


        protected
            int|null
    $customerId
     = null

#[Column]: $name: 'cms_mod_invoicer_customers_customer_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$customerId2


        protected
            int|null
    $customerId2
     = null

#[Column]: $name: 'cms_mod_invoicer_customers_customer_id2'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$customerInformations


        protected
            string|null
    $customerInformations
     = null

#[Column]: $name: 'customer_informations'; $type: 'text'; $nullable: true

$customerName


        protected
            string|null
    $customerName
     = null

#[Column]: $name: 'customer_name'; $type: 'string'; $length: 255; $nullable: true

$customerName2


        protected
            string|null
    $customerName2
     = null

#[Column]: $name: 'customer_name_2'; $type: 'string'; $length: 255; $nullable: true

$customerPhone


        protected
            string|null
    $customerPhone
     = null

#[Column]: $name: 'customer_phone'; $type: 'string'; $length: 255; $nullable: true

$customerPostcode


        protected
            string|null
    $customerPostcode
     = null

Attributes

#[Column]: $name: 'customer_postcode'; $type: 'string'; $length: 20; $nullable: true

$customerRegNo


        protected
            string|null
    $customerRegNo
     = null

#[Column]: $name: 'customer_reg_no'; $type: 'string'; $length: 255; $nullable: true

$customerStreet


        protected
            string|null
    $customerStreet
     = null

#[Column]: $name: 'customer_street'; $type: 'string'; $length: 255; $nullable: true

$customerVatId


        protected
            string|null
    $customerVatId
     = null

#[Column]: $name: 'customer_vat_id'; $type: 'string'; $length: 255; $nullable: true

$customerVatIdCheckId

Applied VAT id check (`cms_system_vat_id_checks`): consultation number or manual proof.


        protected
            int|null
    $customerVatIdCheckId
     = null

#[Column]: $name: 'customer_vat_id_check_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

#[ExternalReadonly]

$customerVatIdOutageCheckId

Record of a VIES outage on the supply date.


        protected
            int|null
    $customerVatIdOutageCheckId
     = null

#[Column]: $name: 'customer_vat_id_outage_check_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

#[ExternalReadonly]

$customerVatIdVerified

Null means the VAT id does not matter (empty or domestic); false is unverified; true is verified.


        protected
            bool|null
    $customerVatIdVerified
     = null

#[Column]: $name: 'customer_vat_id_verified'; $type: 'boolean'; $nullable: true

#[ExternalReadonly]

$customerVatIdVerifiedAt


        protected
            DateTime|null
    $customerVatIdVerifiedAt
     = null

#[Column]: $name: 'customer_vat_id_verified_at'; $type: 'datetime'; $nullable: true

#[ExternalReadonly]

$customerVatInformations


        protected
            string|null
    $customerVatInformations
     = null

#[Column]: $name: 'customer_vat_informations'; $type: 'text'; $nullable: true

$dueDate


        protected
            DateTime|null
    $dueDate
     = null

#[Column]: $name: 'due_date'; $type: 'date'; $nullable: true

$emailBody


        protected
            string|null
    $emailBody
     = null

Attributes

#[Column]: $name: 'email_body'; $type: 'text'; $nullable: true

$emailIsSent


        protected
            bool
    $emailIsSent
     = false

#[Column]: $name: 'email_is_sent'; $type: 'boolean'

#[ExternalReadonly]

$emailSubject


        protected
            string|null
    $emailSubject
     = null

#[Column]: $name: 'email_subject'; $type: 'string'; $length: 255; $nullable: true

$emailTo


        protected
            string|null
    $emailTo
     = null

#[Column]: $name: 'email_to'; $type: 'string'; $length: 255; $nullable: true

$gifts


        protected
            Collection<int, TGift>
    $gifts
     = new ArrayCollection()

$iban


        protected
            string|null
    $iban
     = null

#[Column]: $name: 'iban'; $type: 'string'; $length: 255; $nullable: true

$id


        protected
            int|null
    $id
     = null

#[Column]: $name: 'invoice_id'; $type: 'integer'; $options: ['unsigned' => true]

#[GeneratedValue]

#[Id]

$informations


        protected
            string|null
    $informations
     = null

#[Column]: $name: 'informations'; $type: 'text'; $nullable: true

$insertDatetime


        protected
            DateTime
    $insertDatetime
     = new DateTime()

#[Column]: $name: 'insert_datetime'; $type: 'datetime'

#[ExternalReadonly]

$invoiceTemplateId


        protected
            int|null
    $invoiceTemplateId
     = null

#[Column]: $name: 'cms_mod_invoicer_invoice_templates_invoice_template_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$invoiceTypeId


        protected
            int|null
    $invoiceTypeId
     = null

#[Column]: $name: 'cms_mod_invoicer_invoice_types_invoice_type_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$items


        protected
            Collection<int, TItem>
    $items
     = new ArrayCollection()

$languageId


        protected
            int|null
    $languageId
     = null

#[Column]: $name: 'cms_system_languages_language_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$localization

Localization the document is formatted by (separators, decimals, suffix). Snapshot at issue time: a document must never be formatted by the current request, otherwise a regenerated PDF would differ from the original. Inherited from the order, otherwise from the invoice template. Null (historical documents) falls back to the currency.


        protected
            object|null
    $localization
     = null

#[JoinColumn]: $name: 'cms_system_localizations_localization_id'; $referencedColumnName: 'localization_id'; $onDelete: 'SET NULL'

$lockedDatetime


        protected
            DateTime|null
    $lockedDatetime
     = null

#[Column]: $name: 'locked_datetime'; $type: 'datetime'; $nullable: true

#[ExternalReadonly]

$lockReason


        protected
            string|null
    $lockReason
     = null

#[Column]: $name: 'lock_reason'; $type: 'string'; $length: 20; $nullable: true

#[ExternalReadonly]

$number


        protected
            string|null
    $number
     = null

#[Column]: $name: 'number'; $type: 'string'; $length: 50; $nullable: true

#[ExternalReadonly]

$order


        protected
            int
    $order
     = 0

#[Column]: $name: '`order`'; $type: 'integer'

#[ExternalReadonly]

$orderId


        protected
            int|null
    $orderId
     = null

#[Column]: $name: 'order_id'; $type: 'integer'; $nullable: true

$paymentId


        protected
            int|null
    $paymentId
     = null

#[Column]: $name: 'cms_system_payments_payment_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

#[ExternalReadonly]

$paymentMethodId


        protected
            int|null
    $paymentMethodId
     = null

#[Column]: $name: 'cms_mod_invoicer_payment_methods_payment_method_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$paymentMethods


        protected
            Collection<int, TPaymentMethod>
    $paymentMethods
     = new ArrayCollection()

$paymentRegionId


        protected
            int|null
    $paymentRegionId
     = null

#[Column]: $name: 'cms_system_payment_regions_payment_region_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$pdf


        protected
            string|null
    $pdf
     = null

#[Column]: $name: 'pdf'; $type: 'string'; $length: 255; $nullable: true

#[ExternalReadonly]

$pdfTemplateId


        protected
            int|null
    $pdfTemplateId
     = null

#[Column]: $name: 'cms_system_pdf_templates_pdf_template_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$pdfTemplateVariantId


        protected
            int|null
    $pdfTemplateVariantId
     = null

#[Column]: $name: 'cms_system_pdf_template_variants_pdf_template_variant_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$periodKey


        protected
            string
    $periodKey
     = ''

#[Column]: $name: 'period_key'; $type: 'string'; $length: 20

#[ExternalReadonly]

$productTypeId


        protected
            int|null
    $productTypeId
     = null

#[Column]: $name: 'cms_mod_invoicer_product_types_product_type_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$qrCode


        protected
            string|null
    $qrCode
     = null

#[Column]: $name: 'qr_code'; $type: 'text'; $nullable: true

#[ExternalReadonly]

$relatedInvoiceId


        protected
            int|null
    $relatedInvoiceId
     = null

#[Column]: $name: 'related_invoice_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

#[ExternalReadonly]

$roundedTotalPrice


        protected
            string|null
    $roundedTotalPrice
     = null

#[Column]: $name: 'rounded_total_price'; $type: 'decimal'; $precision: 10; $scale: 3; $nullable: true

#[ExternalReadonly]

$roundedTotalPriceWithVat


        protected
            string|null
    $roundedTotalPriceWithVat
     = null

#[Column]: $name: 'rounded_total_price_with_vat'; $type: 'decimal'; $precision: 10; $scale: 3; $nullable: true

#[ExternalReadonly]

$rounding


        protected
            string|null
    $rounding
     = null

#[Column]: $name: 'rounding'; $type: 'decimal'; $precision: 10; $scale: 3; $nullable: true

#[ExternalReadonly]

$roundingWithVat


        protected
            string|null
    $roundingWithVat
     = null

#[Column]: $name: 'rounding_with_vat'; $type: 'decimal'; $precision: 10; $scale: 3; $nullable: true

#[ExternalReadonly]

$sellerBankAccountId


        protected
            int|null
    $sellerBankAccountId
     = null

#[Column]: $name: 'cms_mod_invoicer_seller_bank_accounts_seller_bank_account_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$sellerCity


        protected
            string|null
    $sellerCity
     = null

#[Column]: $name: 'seller_city'; $type: 'string'; $length: 255; $nullable: true

$sellerContactId


        protected
            int|null
    $sellerContactId
     = null

#[Column]: $name: 'cms_mod_invoicer_seller_contacts_seller_contact_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$sellerCountry


        protected
            string|null
    $sellerCountry
     = null

#[Column]: $name: 'seller_country'; $type: 'string'; $length: 255; $nullable: true

$sellerEmail


        protected
            string|null
    $sellerEmail
     = null

#[Column]: $name: 'seller_email'; $type: 'string'; $length: 255; $nullable: true

$sellerId


        protected
            int|null
    $sellerId
     = null

#[Column]: $name: 'cms_mod_invoicer_sellers_seller_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$sellerInformations


        protected
            string|null
    $sellerInformations
     = null

#[Column]: $name: 'seller_informations'; $type: 'text'; $nullable: true

$sellerName


        protected
            string|null
    $sellerName
     = null

#[Column]: $name: 'seller_name'; $type: 'string'; $length: 255; $nullable: true

$sellerName2


        protected
            string|null
    $sellerName2
     = null

#[Column]: $name: 'seller_name_2'; $type: 'string'; $length: 255; $nullable: true

$sellerPhone


        protected
            string|null
    $sellerPhone
     = null

#[Column]: $name: 'seller_phone'; $type: 'string'; $length: 255; $nullable: true

$sellerPostcode


        protected
            string|null
    $sellerPostcode
     = null

Attributes

#[Column]: $name: 'seller_postcode'; $type: 'string'; $length: 20; $nullable: true

$sellerRegNo


        protected
            string|null
    $sellerRegNo
     = null

#[Column]: $name: 'seller_reg_no'; $type: 'string'; $length: 255; $nullable: true

$sellerStreet


        protected
            string|null
    $sellerStreet
     = null

#[Column]: $name: 'seller_street'; $type: 'string'; $length: 255; $nullable: true

$sellerVatId


        protected
            string|null
    $sellerVatId
     = null

#[Column]: $name: 'seller_vat_id'; $type: 'string'; $length: 255; $nullable: true

$sellerVatInformations


        protected
            string|null
    $sellerVatInformations
     = null

#[Column]: $name: 'seller_vat_informations'; $type: 'text'; $nullable: true

$sendEmail


        protected
            bool
    $sendEmail
     = false

#[Column]: $name: 'send_email'; $type: 'boolean'

$shippers


        protected
            Collection<int, TShipper>
    $shippers
     = new ArrayCollection()

$signature


        protected
            string|null
    $signature
     = null

#[Column]: $name: 'signature'; $type: 'text'; $nullable: true

$specificSymbol


        protected
            string|null
    $specificSymbol
     = null

#[Column]: $name: 'specific_symbol'; $type: 'string'; $length: 255; $nullable: true

$status


        protected
            string
    $status
     = 'unpaid'

#[Column]: $name: 'status'; $type: 'string'; $columnDefinition: "ENUM('paid','unpaid')"

#[ExternalReadonly]

$summaryReportCode

Supply code for the summary report (`3` services, `0` goods); null means it is not reported.


        protected
            string|null
    $summaryReportCode
     = null

Attributes

#[Column]: $name: 'summary_report_code'; $type: 'string'; $length: 1; $nullable: true; $options: ['fixed' => true]

#[ExternalReadonly]

$swift


        protected
            string|null
    $swift
     = null

#[Column]: $name: 'swift'; $type: 'string'; $length: 255; $nullable: true

$taxableSupplyDate


        protected
            DateTime|null
    $taxableSupplyDate
     = null

#[Column]: $name: 'taxable_supply_date'; $type: 'date'; $nullable: true

$taxCountryCode

Country of the applied rate (null without VAT).


        protected
            string|null
    $taxCountryCode
     = null

#[Column]: $name: 'tax_country_code'; $type: 'string'; $length: 2; $nullable: true; $options: ['fixed' => true]

#[ExternalReadonly]

$taxDate

Date of the rate and of the seller status.


        protected
            DateTime|null
    $taxDate
     = null

#[Column]: $name: 'tax_date'; $type: 'date'; $nullable: true

#[ExternalReadonly]

$taxFlags


        protected
            array<int, string>|null
    $taxFlags
     = null

TaxFlag codes

#[Column]: $name: 'tax_flags'; $type: 'json'; $nullable: true

#[ExternalReadonly]

$taxNote

Note in the document language (plus Czech), resolved at creation.


        protected
            string|null
    $taxNote
     = null

#[Column]: $name: 'tax_note'; $type: 'text'; $nullable: true

#[ExternalReadonly]

$taxOverrideReason


        protected
            string|null
    $taxOverrideReason
     = null

#[Column]: $name: 'tax_override_reason'; $type: 'string'; $length: 255; $nullable: true

#[ExternalReadonly]

$taxTreatment

Treatment code; on a payment also the markers `INTERMEDIARY` and `CREDIT_REDEMPTION`.


        protected
            string|null
    $taxTreatment
     = null

#[Column]: $name: 'tax_treatment'; $type: 'string'; $length: 24; $nullable: true

#[ExternalReadonly]

$totalPrice


        protected
            string|null
    $totalPrice
     = null

#[Column]: $name: 'total_price'; $type: 'decimal'; $precision: 10; $scale: 3; $nullable: true

#[ExternalReadonly]

$totalPriceWithVat


        protected
            string|null
    $totalPriceWithVat
     = null

#[Column]: $name: 'total_price_with_vat'; $type: 'decimal'; $precision: 10; $scale: 3; $nullable: true

#[ExternalReadonly]

$useDeliveryAddress


        protected
            bool
    $useDeliveryAddress
     = false

#[Column]: $name: 'use_delivery_address'; $type: 'boolean'

$userTypeId


        protected
            int|null
    $userTypeId
     = null

#[Column]: $name: 'cms_system_user_types_user_type_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$useVat


        protected
            bool
    $useVat
     = false

#[Column]: $name: 'use_vat'; $type: 'boolean'

$variableSymbol


        protected
            string|null
    $variableSymbol
     = null

#[Column]: $name: 'variable_symbol'; $type: 'string'; $length: 255; $nullable: true

$vouchers


        protected
            Collection<int, TVoucher>
    $vouchers
     = new ArrayCollection()

__construct()


    public
                    __construct([int|null $id = null ][, string|null $number = null ][, int $order = 0 ][, string $periodKey = '' ][, int|null $invoiceTypeId = null ][, int|null $productTypeId = null ][, int|null $pdfTemplateId = null ][, int|null $pdfTemplateVariantId = null ][, string|null $pdf = null ][, string|null $variableSymbol = null ][, string|null $constantSymbol = null ][, string|null $specificSymbol = null ][, DateTime|null $taxableSupplyDate = null ][, DateTime|null $dueDate = null ][, DateTime $creationDate = new DateTime() ][, string $status = 'unpaid' ][, DateTime $insertDatetime = new DateTime() ][, int|null $sellerId = null ][, int|null $sellerContactId = null ][, string|null $sellerName = null ][, string|null $sellerName2 = null ][, string|null $sellerEmail = null ][, string|null $sellerPhone = null ][, string|null $sellerRegNo = null ][, string|null $sellerVatId = null ][, string|null $sellerStreet = null ][, string|null $sellerCity = null ][, string|null $sellerPostcode = null ][, string|null $sellerCountry = null ][, string|null $sellerInformations = null ][, string|null $sellerVatInformations = null ][, int|null $customerId = null ][, int|null $customerContactId = null ][, string|null $customerName = null ][, string|null $customerName2 = null ][, string|null $customerEmail = null ][, string|null $customerPhone = null ][, string|null $customerRegNo = null ][, string|null $customerVatId = null ][, string|null $customerStreet = null ][, string|null $customerCity = null ][, string|null $customerPostcode = null ][, string|null $customerCountry = null ][, string|null $customerCountryCode = null ][, string|null $customerDlvCountryCode = null ][, string|null $taxOverrideReason = null ][, string|null $customerInformations = null ][, string|null $customerVatInformations = null ][, int|null $billingLineId = null ][, int|null $paymentMethodId = null ][, bool $useVat = false ][, string|null $bankName = null ][, string|null $bankAccount = null ][, string|null $iban = null ][, string|null $swift = null ][, string|null $informations = null ][, int|null $currencyId = null ][, int|null $sellerBankAccountId = null ][, string|null $totalPrice = null ][, string|null $totalPriceWithVat = null ][, string|null $rounding = null ][, string|null $roundingWithVat = null ][, string|null $roundedTotalPrice = null ][, string|null $roundedTotalPriceWithVat = null ][, string|null $signature = null ][, bool $sendEmail = false ][, string|null $emailTo = null ][, string|null $emailSubject = null ][, string|null $emailBody = null ][, bool $emailIsSent = false ][, DateTime|null $lockedDatetime = null ][, string|null $lockReason = null ][, int|null $paymentRegionId = null ][, int|null $languageId = null ][, int|null $orderId = null ][, int|null $userTypeId = null ][, bool $useDeliveryAddress = false ][, string|null $customerDlvName = null ][, string|null $customerDlvName2 = null ][, string|null $customerDlvStreet = null ][, string|null $customerDlvCity = null ][, string|null $customerDlvPostcode = null ][, string|null $customerDlvCountry = null ][, string|null $customerDlvInformations = null ][, int|null $customerId2 = null ][, int|null $customerContactId2 = null ][, int|null $paymentId = null ][, string|null $qrCode = null ][, int|null $invoiceTemplateId = null ][, int|null $relatedInvoiceId = null ][, Collection $items = new ArrayCollection() ][, Collection $gifts = new ArrayCollection() ][, Collection $vouchers = new ArrayCollection() ][, Collection $shippers = new ArrayCollection() ][, Collection $paymentMethods = new ArrayCollection() ][, mixed $localization = null ][, int|null $localizationId = null ]) : mixed

Parameters

$id : int|null = null
$number : string|null = null
$order : int = 0
$periodKey : string = ''
$invoiceTypeId : int|null = null
$productTypeId : int|null = null
$pdfTemplateId : int|null = null
$pdfTemplateVariantId : int|null = null
$pdf : string|null = null
$variableSymbol : string|null = null
$constantSymbol : string|null = null
$specificSymbol : string|null = null
$taxableSupplyDate : DateTime|null = null
$dueDate : DateTime|null = null
$creationDate : DateTime = new DateTime()
$status : string = 'unpaid'
$insertDatetime : DateTime = new DateTime()
$sellerId : int|null = null
$sellerContactId : int|null = null
$sellerName : string|null = null
$sellerName2 : string|null = null
$sellerEmail : string|null = null
$sellerPhone : string|null = null
$sellerRegNo : string|null = null
$sellerVatId : string|null = null
$sellerStreet : string|null = null
$sellerCity : string|null = null
$sellerPostcode : string|null = null
$sellerCountry : string|null = null
$sellerInformations : string|null = null
$sellerVatInformations : string|null = null
$customerId : int|null = null
$customerContactId : int|null = null
$customerName : string|null = null
$customerName2 : string|null = null
$customerEmail : string|null = null
$customerPhone : string|null = null
$customerRegNo : string|null = null
$customerVatId : string|null = null
$customerStreet : string|null = null
$customerCity : string|null = null
$customerPostcode : string|null = null
$customerCountry : string|null = null
$customerCountryCode : string|null = null
$customerDlvCountryCode : string|null = null
$taxOverrideReason : string|null = null
$customerInformations : string|null = null
$customerVatInformations : string|null = null
$billingLineId : int|null = null
$paymentMethodId : int|null = null
$useVat : bool = false
$bankName : string|null = null
$bankAccount : string|null = null
$iban : string|null = null
$swift : string|null = null
$informations : string|null = null
$currencyId : int|null = null
$sellerBankAccountId : int|null = null
$totalPrice : string|null = null
$totalPriceWithVat : string|null = null
$rounding : string|null = null
$roundingWithVat : string|null = null
$roundedTotalPrice : string|null = null
$roundedTotalPriceWithVat : string|null = null
$signature : string|null = null
$sendEmail : bool = false
$emailTo : string|null = null
$emailSubject : string|null = null
$emailBody : string|null = null
$emailIsSent : bool = false
$lockedDatetime : DateTime|null = null
$lockReason : string|null = null
$paymentRegionId : int|null = null
$languageId : int|null = null
$orderId : int|null = null
$userTypeId : int|null = null
$useDeliveryAddress : bool = false
$customerDlvName : string|null = null
$customerDlvName2 : string|null = null
$customerDlvStreet : string|null = null
$customerDlvCity : string|null = null
$customerDlvPostcode : string|null = null
$customerDlvCountry : string|null = null
$customerDlvInformations : string|null = null
$customerId2 : int|null = null
$customerContactId2 : int|null = null
$paymentId : int|null = null
$qrCode : string|null = null
$invoiceTemplateId : int|null = null
$relatedInvoiceId : int|null = null
$items : Collection = new ArrayCollection()
$gifts : Collection = new ArrayCollection()
$vouchers : Collection = new ArrayCollection()
$shippers : Collection = new ArrayCollection()
$paymentMethods : Collection = new ArrayCollection()
$localization : mixed = null
$localizationId : int|null = null

addGift()


    public
                    addGift(TGift $gift) : $this

Parameters

$gift : TGift

Return values

$this

addItem()


    public
                    addItem(TItem $item) : $this

Parameters

$item : TItem

Return values

$this

addPaymentMethod()


    public
                    addPaymentMethod(TPaymentMethod $paymentMethod) : $this

Parameters

$paymentMethod : TPaymentMethod

Return values

$this

addShipper()


    public
                    addShipper(TShipper $shipper) : $this

Parameters

$shipper : TShipper

Return values

$this

addVoucher()


    public
                    addVoucher(TVoucher $voucher) : $this

Parameters

$voucher : TVoucher

Return values

$this

callInitMethods()

Calls `init{TraitName}()` for every used trait that defines such a method.


    public
                    callInitMethods() : void

clearGifts()


    public
                    clearGifts() : $this

Return values

$this

clearItems()


    public
                    clearItems() : $this

Return values

$this

clearPaymentMethods()


    public
                    clearPaymentMethods() : $this

Return values

$this

clearShippers()


    public
                    clearShippers() : $this

Return values

$this

clearVouchers()


    public
                    clearVouchers() : $this

Return values

$this

getAllTraits()

Returns all traits the class uses, including those used by parent classes and nested traits.


    public
                    getAllTraits() : array<string, string>

Return values

array<string, string>

getBankAccount()


    public
                    getBankAccount() : string|null

Return values

string|null

getBankName()


    public
                    getBankName() : string|null

Return values

string|null

getBillingLineId()


    public
                    getBillingLineId() : int|null

Return values

int|null

getConstantSymbol()


    public
                    getConstantSymbol() : string|null

Return values

string|null

getCreationDate()


    public
                    getCreationDate() : DateTime

Return values

DateTime

getCurrencyId()


    public
                    getCurrencyId() : int|null

Return values

int|null

getCustomerCity()


    public
                    getCustomerCity() : string|null

Return values

string|null

getCustomerContactId()


    public
                    getCustomerContactId() : int|null

Return values

int|null

getCustomerContactId2()


    public
                    getCustomerContactId2() : int|null

Return values

int|null

getCustomerCountry()


    public
                    getCustomerCountry() : string|null

Return values

string|null

getCustomerCountryCode()


    public
                    getCustomerCountryCode() : string|null

Return values

string|null

getCustomerDlvCity()


    public
                    getCustomerDlvCity() : string|null

Return values

string|null

getCustomerDlvCountry()


    public
                    getCustomerDlvCountry() : string|null

Return values

string|null

getCustomerDlvCountryCode()


    public
                    getCustomerDlvCountryCode() : string|null

Return values

string|null

getCustomerDlvInformations()


    public
                    getCustomerDlvInformations() : string|null

Return values

string|null

getCustomerDlvName()


    public
                    getCustomerDlvName() : string|null

Return values

string|null

getCustomerDlvName2()


    public
                    getCustomerDlvName2() : string|null

Return values

string|null

getCustomerDlvPostcode()


    public
                    getCustomerDlvPostcode() : string|null

Return values

string|null

getCustomerDlvStreet()


    public
                    getCustomerDlvStreet() : string|null

Return values

string|null

getCustomerEmail()


    public
                    getCustomerEmail() : string|null

Return values

string|null

getCustomerId()


    public
                    getCustomerId() : int|null

Return values

int|null

getCustomerId2()


    public
                    getCustomerId2() : int|null

Return values

int|null

getCustomerInformations()


    public
                    getCustomerInformations() : string|null

Return values

string|null

getCustomerName()


    public
                    getCustomerName() : string|null

Return values

string|null

getCustomerName2()


    public
                    getCustomerName2() : string|null

Return values

string|null

getCustomerPhone()


    public
                    getCustomerPhone() : string|null

Return values

string|null

getCustomerPostcode()


    public
                    getCustomerPostcode() : string|null

Return values

string|null

getCustomerRegNo()


    public
                    getCustomerRegNo() : string|null

Return values

string|null

getCustomerStreet()


    public
                    getCustomerStreet() : string|null

Return values

string|null

getCustomerVatId()


    public
                    getCustomerVatId() : string|null

Return values

string|null

getCustomerVatIdCheckId()


    public
                    getCustomerVatIdCheckId() : int|null

Return values

int|null

getCustomerVatIdOutageCheckId()


    public
                    getCustomerVatIdOutageCheckId() : int|null

Return values

int|null

getCustomerVatIdVerified()


    public
                    getCustomerVatIdVerified() : bool|null

Return values

bool|null

getCustomerVatIdVerifiedAt()


    public
                    getCustomerVatIdVerifiedAt() : DateTime|null

Return values

DateTime|null

getCustomerVatInformations()


    public
                    getCustomerVatInformations() : string|null

Return values

string|null

getDueDate()


    public
                    getDueDate() : DateTime|null

Return values

DateTime|null

getEmailBody()


    public
                    getEmailBody() : string|null

Return values

string|null

getEmailIsSent()


    public
                    getEmailIsSent() : bool

Return values

bool

getEmailSubject()


    public
                    getEmailSubject() : string|null

Return values

string|null

getEmailTo()


    public
                    getEmailTo() : string|null

Return values

string|null

getGift()


    public
                    getGift(int $giftId) : TGift|null

Parameters

$giftId : int

Return values

TGift|null

getGifts()


    public
                    getGifts() : Collection<int, TGift>

Return values

Collection<int, TGift>

getIban()


    public
                    getIban() : string|null

Return values

string|null

getId()


    public
                    getId() : int|null

Return values

int|null

getInformations()


    public
                    getInformations() : string|null

Return values

string|null

getInsertDatetime()


    public
                    getInsertDatetime() : DateTime

Return values

DateTime

getInvoiceTemplateId()


    public
                    getInvoiceTemplateId() : int|null

Return values

int|null

getInvoiceTypeId()


    public
                    getInvoiceTypeId() : int|null

Return values

int|null

getItem()


    public
                    getItem(int $itemId) : TItem|null

Parameters

$itemId : int

Return values

TItem|null

getItems()


    public
                    getItems() : Collection<int, TItem>

Return values

Collection<int, TItem>

getLanguageId()


    public
                    getLanguageId() : int|null

Return values

int|null

getLocalization()


    public
                    getLocalization() : object|null

Return values

object|null

getLocalizationId()

The object wins over the scalar (a freshly set localization beats the mirror loaded from the DB), but `$localization` is an untyped `object`, hence the guard instead of a plain `?->getId()`. Without it PHPStan reports `object::getId()` and a foreign object in the association would fail at runtime.


    public
                    getLocalizationId() : int|null

Return values

int|null

getLockedDatetime()


    public
                    getLockedDatetime() : DateTime|null

Return values

DateTime|null

getLockReason()


    public
                    getLockReason() : string|null

Return values

string|null

getNumber()


    public
                    getNumber() : string|null

Return values

string|null

getOrder()


    public
                    getOrder() : int

Return values

int

getOrderId()


    public
                    getOrderId() : int|null

Return values

int|null

getPaymentId()


    public
                    getPaymentId() : int|null

Return values

int|null

getPaymentMethodId()


    public
                    getPaymentMethodId() : int|null

Return values

int|null

getPaymentMethods()


    public
                    getPaymentMethods() : Collection<int, TPaymentMethod>

Return values

Collection<int, TPaymentMethod>

getPaymentRegionId()


    public
                    getPaymentRegionId() : int|null

Return values

int|null

getPdf()


    public
                    getPdf() : string|null

Return values

string|null

getPdfTemplateId()


    public
                    getPdfTemplateId() : int|null

Return values

int|null

getPdfTemplateVariantId()


    public
                    getPdfTemplateVariantId() : int|null

Return values

int|null

getPeriodKey()


    public
                    getPeriodKey() : string

Return values

string

getProductTypeId()


    public
                    getProductTypeId() : int|null

Return values

int|null

getQrCode()


    public
                    getQrCode() : string|null

Return values

string|null

getRelatedInvoiceId()


    public
                    getRelatedInvoiceId() : int|null

Return values

int|null

getRoundedTotalPrice()


    public
                    getRoundedTotalPrice() : string|null

Return values

string|null

getRoundedTotalPriceWithVat()


    public
                    getRoundedTotalPriceWithVat() : string|null

Return values

string|null

getRounding()


    public
                    getRounding() : string|null

Return values

string|null

getRoundingWithVat()


    public
                    getRoundingWithVat() : string|null

Return values

string|null

getSellerBankAccountId()


    public
                    getSellerBankAccountId() : int|null

Return values

int|null

getSellerCity()


    public
                    getSellerCity() : string|null

Return values

string|null

getSellerContactId()


    public
                    getSellerContactId() : int|null

Return values

int|null

getSellerCountry()


    public
                    getSellerCountry() : string|null

Return values

string|null

getSellerEmail()


    public
                    getSellerEmail() : string|null

Return values

string|null

getSellerId()


    public
                    getSellerId() : int|null

Return values

int|null

getSellerInformations()


    public
                    getSellerInformations() : string|null

Return values

string|null

getSellerName()


    public
                    getSellerName() : string|null

Return values

string|null

getSellerName2()


    public
                    getSellerName2() : string|null

Return values

string|null

getSellerPhone()


    public
                    getSellerPhone() : string|null

Return values

string|null

getSellerPostcode()


    public
                    getSellerPostcode() : string|null

Return values

string|null

getSellerRegNo()


    public
                    getSellerRegNo() : string|null

Return values

string|null

getSellerStreet()


    public
                    getSellerStreet() : string|null

Return values

string|null

getSellerVatId()


    public
                    getSellerVatId() : string|null

Return values

string|null

getSellerVatInformations()


    public
                    getSellerVatInformations() : string|null

Return values

string|null

getSendEmail()


    public
                    getSendEmail() : bool

Return values

bool

getShippers()


    public
                    getShippers() : Collection<int, TShipper>

Return values

Collection<int, TShipper>

getSignature()


    public
                    getSignature() : string|null

Return values

string|null

getSpecificSymbol()


    public
                    getSpecificSymbol() : string|null

Return values

string|null

getStatus()


    public
                    getStatus() : string

Return values

string

getSummaryReportCode()


    public
                    getSummaryReportCode() : string|null

Return values

string|null

getSwift()


    public
                    getSwift() : string|null

Return values

string|null

getTaxableSupplyDate()


    public
                    getTaxableSupplyDate() : DateTime|null

Return values

DateTime|null

getTaxCountryCode()


    public
                    getTaxCountryCode() : string|null

Return values

string|null

getTaxDate()


    public
                    getTaxDate() : DateTime|null

Return values

DateTime|null

getTaxFlags()


    public
                    getTaxFlags() : array<int, string>|null

Return values

array<int, string>|null

getTaxNote()


    public
                    getTaxNote() : string|null

Return values

string|null

getTaxOverrideReason()


    public
                    getTaxOverrideReason() : string|null

Return values

string|null

getTaxTreatment()


    public
                    getTaxTreatment() : string|null

Return values

string|null

getTotalPrice()


    public
                    getTotalPrice() : string|null

Return values

string|null

getTotalPriceWithVat()


    public
                    getTotalPriceWithVat() : string|null

Return values

string|null

getUseDeliveryAddress()


    public
                    getUseDeliveryAddress() : bool

Return values

bool

getUserTypeId()


    public
                    getUserTypeId() : int|null

Return values

int|null

getUseVat()


    public
                    getUseVat() : bool

Return values

bool

getVariableSymbol()


    public
                    getVariableSymbol() : string|null

Return values

string|null

getVoucher()


    public
                    getVoucher(int $voucherId) : TVoucher|null

Parameters

$voucherId : int

Return values

TVoucher|null

getVouchers()


    public
                    getVouchers() : Collection<int, TVoucher>

Return values

Collection<int, TVoucher>

giftCollectionInit()


    public
                    giftCollectionInit() : void

hasTaxFlag()


    public
                    hasTaxFlag(string $flag) : bool

Parameters

$flag : string

Return values

bool

isEmailSent()


    public
                    isEmailSent() : bool

Return values

bool

isLocked()

Locked invoice: amounts, lines and customer can no longer be changed; fix it with a credit note.


    public
                    isLocked() : bool

Return values

bool

isPersisted()


    public
                    isPersisted() : bool

Return values

bool

isSendEmail()


    public
                    isSendEmail() : bool

Return values

bool

isUseDeliveryAddress()


    public
                    isUseDeliveryAddress() : bool

Return values

bool

isUseVat()


    public
                    isUseVat() : bool

Return values

bool

itemCollectionInit()


    public
                    itemCollectionInit() : void

paymentMethodCollectionInit()


    public
                    paymentMethodCollectionInit() : void

removeGift()


    public
                    removeGift(TGift $gift) : $this

Parameters

$gift : TGift

Return values

$this

removeItem()


    public
                    removeItem(TItem $item) : $this

Parameters

$item : TItem

Return values

$this

removePaymentMethod()


    public
                    removePaymentMethod(TPaymentMethod $paymentMethod) : $this

Parameters

$paymentMethod : TPaymentMethod

Return values

$this

removeShipper()


    public
                    removeShipper(TShipper $shipper) : $this

Parameters

$shipper : TShipper

Return values

$this

removeVoucher()


    public
                    removeVoucher(TVoucher $voucher) : $this

Parameters

$voucher : TVoucher

Return values

$this

setBankAccount()


    public
                    setBankAccount(string|null $bankAccount) : $this

Parameters

$bankAccount : string|null

Return values

$this

setBankName()


    public
                    setBankName(string|null $bankName) : $this

Parameters

$bankName : string|null

Return values

$this

setBillingLineId()


    public
                    setBillingLineId(int|null $billingLineId) : $this

Parameters

$billingLineId : int|null

Return values

$this

setConstantSymbol()


    public
                    setConstantSymbol(string|null $constantSymbol) : $this

Parameters

$constantSymbol : string|null

Return values

$this

setCreationDate()


    public
                    setCreationDate(DateTime $creationDate) : $this

Parameters

$creationDate : DateTime

Return values

$this

setCurrencyId()


    public
                    setCurrencyId(int|null $currencyId) : $this

Parameters

$currencyId : int|null

Return values

$this

setCustomerCity()


    public
                    setCustomerCity(string|null $customerCity) : $this

Parameters

$customerCity : string|null

Return values

$this

setCustomerContactId()


    public
                    setCustomerContactId(int|null $customerContactId) : $this

Parameters

$customerContactId : int|null

Return values

$this

setCustomerContactId2()


    public
                    setCustomerContactId2(int|null $customerContactId2) : $this

Parameters

$customerContactId2 : int|null

Return values

$this

setCustomerCountry()


    public
                    setCustomerCountry(string|null $customerCountry) : $this

Parameters

$customerCountry : string|null

Return values

$this

setCustomerCountryCode()


    public
                    setCustomerCountryCode(string|null $customerCountryCode) : $this

Parameters

$customerCountryCode : string|null

Return values

$this

setCustomerDlvCity()


    public
                    setCustomerDlvCity(string|null $customerDlvCity) : $this

Parameters

$customerDlvCity : string|null

Return values

$this

setCustomerDlvCountry()


    public
                    setCustomerDlvCountry(string|null $customerDlvCountry) : $this

Parameters

$customerDlvCountry : string|null

Return values

$this

setCustomerDlvCountryCode()


    public
                    setCustomerDlvCountryCode(string|null $customerDlvCountryCode) : $this

Parameters

$customerDlvCountryCode : string|null

Return values

$this

setCustomerDlvInformations()


    public
                    setCustomerDlvInformations(string|null $customerDlvInformations) : $this

Parameters

$customerDlvInformations : string|null

Return values

$this

setCustomerDlvName()


    public
                    setCustomerDlvName(string|null $customerDlvName) : $this

Parameters

$customerDlvName : string|null

Return values

$this

setCustomerDlvName2()


    public
                    setCustomerDlvName2(string|null $customerDlvName2) : $this

Parameters

$customerDlvName2 : string|null

Return values

$this

setCustomerDlvPostcode()


    public
                    setCustomerDlvPostcode(string|null $customerDlvPostcode) : $this

Parameters

$customerDlvPostcode : string|null

Return values

$this

setCustomerDlvStreet()


    public
                    setCustomerDlvStreet(string|null $customerDlvStreet) : $this

Parameters

$customerDlvStreet : string|null

Return values

$this

setCustomerEmail()


    public
                    setCustomerEmail(string|null $customerEmail) : $this

Parameters

$customerEmail : string|null

Return values

$this

setCustomerId()


    public
                    setCustomerId(int|null $customerId) : $this

Parameters

$customerId : int|null

Return values

$this

setCustomerId2()


    public
                    setCustomerId2(int|null $customerId2) : $this

Parameters

$customerId2 : int|null

Return values

$this

setCustomerInformations()


    public
                    setCustomerInformations(string|null $customerInformations) : $this

Parameters

$customerInformations : string|null

Return values

$this

setCustomerName()


    public
                    setCustomerName(string|null $customerName) : $this

Parameters

$customerName : string|null

Return values

$this

setCustomerName2()


    public
                    setCustomerName2(string|null $customerName2) : $this

Parameters

$customerName2 : string|null

Return values

$this

setCustomerPhone()


    public
                    setCustomerPhone(string|null $customerPhone) : $this

Parameters

$customerPhone : string|null

Return values

$this

setCustomerPostcode()


    public
                    setCustomerPostcode(string|null $customerPostcode) : $this

Parameters

$customerPostcode : string|null

Return values

$this

setCustomerRegNo()


    public
                    setCustomerRegNo(string|null $customerRegNo) : $this

Parameters

$customerRegNo : string|null

Return values

$this

setCustomerStreet()


    public
                    setCustomerStreet(string|null $customerStreet) : $this

Parameters

$customerStreet : string|null

Return values

$this

setCustomerVatId()


    public
                    setCustomerVatId(string|null $customerVatId) : $this

Parameters

$customerVatId : string|null

Return values

$this

setCustomerVatIdCheckId()


    public
                    setCustomerVatIdCheckId(int|null $customerVatIdCheckId) : static

Parameters

$customerVatIdCheckId : int|null

Return values

static

setCustomerVatIdOutageCheckId()


    public
                    setCustomerVatIdOutageCheckId(int|null $customerVatIdOutageCheckId) : static

Parameters

$customerVatIdOutageCheckId : int|null

Return values

static

setCustomerVatIdVerified()


    public
                    setCustomerVatIdVerified(bool|null $customerVatIdVerified) : static

Parameters

$customerVatIdVerified : bool|null

Return values

static

setCustomerVatIdVerifiedAt()


    public
                    setCustomerVatIdVerifiedAt(DateTime|null $customerVatIdVerifiedAt) : static

Parameters

$customerVatIdVerifiedAt : DateTime|null

Return values

static

setCustomerVatInformations()


    public
                    setCustomerVatInformations(string|null $customerVatInformations) : $this

Parameters

$customerVatInformations : string|null

Return values

$this

setDueDate()


    public
                    setDueDate(DateTime|null $dueDate) : $this

Parameters

$dueDate : DateTime|null

Return values

$this

setEmailBody()


    public
                    setEmailBody(string|null $emailBody) : $this

Parameters

$emailBody : string|null

Return values

$this

setEmailIsSent()


    public
                    setEmailIsSent(bool $emailIsSent) : $this

Parameters

$emailIsSent : bool

Return values

$this

setEmailSubject()


    public
                    setEmailSubject(string|null $emailSubject) : $this

Parameters

$emailSubject : string|null

Return values

$this

setEmailTo()


    public
                    setEmailTo(string|null $emailTo) : $this

Parameters

$emailTo : string|null

Return values

$this

setGifts()


    public
                    setGifts(Collection<int, TGift>|array<int, TGift> $gifts) : $this

Parameters

$gifts : Collection<int, TGift>|array<int, TGift>

Return values

$this

setIban()


    public
                    setIban(string|null $iban) : $this

Parameters

$iban : string|null

Return values

$this

setId()


    public
                    setId(int|null $id) : $this

Parameters

$id : int|null

Return values

$this

setInformations()


    public
                    setInformations(string|null $informations) : $this

Parameters

$informations : string|null

Return values

$this

setInsertDatetime()


    public
                    setInsertDatetime(DateTime $insertDatetime) : $this

Parameters

$insertDatetime : DateTime

Return values

$this

setInvoiceTemplateId()


    public
                    setInvoiceTemplateId(int|null $invoiceTemplateId) : $this

Parameters

$invoiceTemplateId : int|null

Return values

$this

setInvoiceTypeId()


    public
                    setInvoiceTypeId(int|null $invoiceTypeId) : $this

Parameters

$invoiceTypeId : int|null

Return values

$this

setItems()


    public
                    setItems(Collection<int, TItem>|array<int, TItem> $items) : $this

Parameters

$items : Collection<int, TItem>|array<int, TItem>

Return values

$this

setLanguageId()


    public
                    setLanguageId(int|null $languageId) : $this

Parameters

$languageId : int|null

Return values

$this

setLocalization()

IMPORTANT: deliberately without the side effect `$this->localizationId = $localization?->getId()`.


    public
                    setLocalization(object|null $localization) : $this

With two-phase hydration the setter runs before the shell gets its id and would overwrite the correctly loaded read-only scalar with null.

Parameters

$localization : object|null

Return values

$this

setLocalizationId()

The FK mirror is set by the form together with the association: Api `resolveRelations()` fills a null association from the mirror (entity loaded without include), so clearing the localization must not carry the old mirror over. In the DB the column is written only through the association.


    public
                    setLocalizationId(int|null $localizationId) : $this

Parameters

$localizationId : int|null

Return values

$this

setLockedDatetime()


    public
                    setLockedDatetime(DateTime|null $lockedDatetime) : $this

Parameters

$lockedDatetime : DateTime|null

Return values

$this

setLockReason()


    public
                    setLockReason(string|null $lockReason) : $this

Parameters

$lockReason : string|null

Return values

$this

setNumber()


    public
                    setNumber(string|null $number) : $this

Parameters

$number : string|null

Return values

$this

setOrder()


    public
                    setOrder(int $order) : $this

Parameters

$order : int

Return values

$this

setOrderId()


    public
                    setOrderId(int|null $orderId) : $this

Parameters

$orderId : int|null

Return values

$this

setPaymentId()


    public
                    setPaymentId(int|null $paymentId) : $this

Parameters

$paymentId : int|null

Return values

$this

setPaymentMethodId()


    public
                    setPaymentMethodId(int|null $paymentMethodId) : $this

Parameters

$paymentMethodId : int|null

Return values

$this

setPaymentMethods()


    public
                    setPaymentMethods(Collection<int, TPaymentMethod>|array<int, TPaymentMethod> $paymentMethods) : $this

Parameters

$paymentMethods : Collection<int, TPaymentMethod>|array<int, TPaymentMethod>

Return values

$this

setPaymentRegionId()


    public
                    setPaymentRegionId(int|null $paymentRegionId) : $this

Parameters

$paymentRegionId : int|null

Return values

$this

setPdf()


    public
                    setPdf(string|null $pdf) : $this

Parameters

$pdf : string|null

Return values

$this

setPdfTemplateId()


    public
                    setPdfTemplateId(int|null $pdfTemplateId) : $this

Parameters

$pdfTemplateId : int|null

Return values

$this

setPdfTemplateVariantId()


    public
                    setPdfTemplateVariantId(int|null $pdfTemplateVariantId) : $this

Parameters

$pdfTemplateVariantId : int|null

Return values

$this

setPeriodKey()


    public
                    setPeriodKey(string $periodKey) : $this

Parameters

$periodKey : string

Return values

$this

setProductTypeId()


    public
                    setProductTypeId(int|null $productTypeId) : $this

Parameters

$productTypeId : int|null

Return values

$this

setQrCode()


    public
                    setQrCode(string|null $qrCode) : $this

Parameters

$qrCode : string|null

Return values

$this

setRelatedInvoiceId()


    public
                    setRelatedInvoiceId(int|null $relatedInvoiceId) : $this

Parameters

$relatedInvoiceId : int|null

Return values

$this

setRoundedTotalPrice()


    public
                    setRoundedTotalPrice(string|null $roundedTotalPrice) : $this

Parameters

$roundedTotalPrice : string|null

Return values

$this

setRoundedTotalPriceWithVat()


    public
                    setRoundedTotalPriceWithVat(string|null $roundedTotalPriceWithVat) : $this

Parameters

$roundedTotalPriceWithVat : string|null

Return values

$this

setRounding()


    public
                    setRounding(string|null $rounding) : $this

Parameters

$rounding : string|null

Return values

$this

setRoundingWithVat()


    public
                    setRoundingWithVat(string|null $roundingWithVat) : $this

Parameters

$roundingWithVat : string|null

Return values

$this

setSellerBankAccountId()


    public
                    setSellerBankAccountId(int|null $sellerBankAccountId) : $this

Parameters

$sellerBankAccountId : int|null

Return values

$this

setSellerCity()


    public
                    setSellerCity(string|null $sellerCity) : $this

Parameters

$sellerCity : string|null

Return values

$this

setSellerContactId()


    public
                    setSellerContactId(int|null $sellerContactId) : $this

Parameters

$sellerContactId : int|null

Return values

$this

setSellerCountry()


    public
                    setSellerCountry(string|null $sellerCountry) : $this

Parameters

$sellerCountry : string|null

Return values

$this

setSellerEmail()


    public
                    setSellerEmail(string|null $sellerEmail) : $this

Parameters

$sellerEmail : string|null

Return values

$this

setSellerId()


    public
                    setSellerId(int|null $sellerId) : $this

Parameters

$sellerId : int|null

Return values

$this

setSellerInformations()


    public
                    setSellerInformations(string|null $sellerInformations) : $this

Parameters

$sellerInformations : string|null

Return values

$this

setSellerName()


    public
                    setSellerName(string|null $sellerName) : $this

Parameters

$sellerName : string|null

Return values

$this

setSellerName2()


    public
                    setSellerName2(string|null $sellerName2) : $this

Parameters

$sellerName2 : string|null

Return values

$this

setSellerPhone()


    public
                    setSellerPhone(string|null $sellerPhone) : $this

Parameters

$sellerPhone : string|null

Return values

$this

setSellerPostcode()


    public
                    setSellerPostcode(string|null $sellerPostcode) : $this

Parameters

$sellerPostcode : string|null

Return values

$this

setSellerRegNo()


    public
                    setSellerRegNo(string|null $sellerRegNo) : $this

Parameters

$sellerRegNo : string|null

Return values

$this

setSellerStreet()


    public
                    setSellerStreet(string|null $sellerStreet) : $this

Parameters

$sellerStreet : string|null

Return values

$this

setSellerVatId()


    public
                    setSellerVatId(string|null $sellerVatId) : $this

Parameters

$sellerVatId : string|null

Return values

$this

setSellerVatInformations()


    public
                    setSellerVatInformations(string|null $sellerVatInformations) : $this

Parameters

$sellerVatInformations : string|null

Return values

$this

setSendEmail()


    public
                    setSendEmail(bool $sendEmail) : $this

Parameters

$sendEmail : bool

Return values

$this

setShippers()


    public
                    setShippers(Collection<int, TShipper>|array<int, TShipper> $shippers) : $this

Parameters

$shippers : Collection<int, TShipper>|array<int, TShipper>

Return values

$this

setSignature()


    public
                    setSignature(string|null $signature) : $this

Parameters

$signature : string|null

Return values

$this

setSpecificSymbol()


    public
                    setSpecificSymbol(string|null $specificSymbol) : $this

Parameters

$specificSymbol : string|null

Return values

$this

setStatus()


    public
                    setStatus(string $status) : $this

Parameters

$status : string

Return values

$this

setSummaryReportCode()


    public
                    setSummaryReportCode(string|null $summaryReportCode) : static

Parameters

$summaryReportCode : string|null

Return values

static

setSwift()


    public
                    setSwift(string|null $swift) : $this

Parameters

$swift : string|null

Return values

$this

setTaxableSupplyDate()


    public
                    setTaxableSupplyDate(DateTime|null $taxableSupplyDate) : $this

Parameters

$taxableSupplyDate : DateTime|null

Return values

$this

setTaxCountryCode()


    public
                    setTaxCountryCode(string|null $taxCountryCode) : static

Parameters

$taxCountryCode : string|null

Return values

static

setTaxDate()


    public
                    setTaxDate(DateTime|null $taxDate) : static

Parameters

$taxDate : DateTime|null

Return values

static

setTaxFlags()


    public
                    setTaxFlags(array<int, string>|null $taxFlags) : static

Parameters

$taxFlags : array<int, string>|null

Return values

static

setTaxNote()


    public
                    setTaxNote(string|null $taxNote) : static

Parameters

$taxNote : string|null

Return values

static

setTaxOverrideReason()


    public
                    setTaxOverrideReason(string|null $taxOverrideReason) : $this

Parameters

$taxOverrideReason : string|null

Return values

$this

setTaxTreatment()


    public
                    setTaxTreatment(string|null $taxTreatment) : static

Parameters

$taxTreatment : string|null

Return values

static

setTotalPrice()


    public
                    setTotalPrice(string|null $totalPrice) : $this

Parameters

$totalPrice : string|null

Return values

$this

setTotalPriceWithVat()


    public
                    setTotalPriceWithVat(string|null $totalPriceWithVat) : $this

Parameters

$totalPriceWithVat : string|null

Return values

$this

setUseDeliveryAddress()


    public
                    setUseDeliveryAddress(bool $useDeliveryAddress) : $this

Parameters

$useDeliveryAddress : bool

Return values

$this

setUserTypeId()


    public
                    setUserTypeId(int|null $userTypeId) : $this

Parameters

$userTypeId : int|null

Return values

$this

setUseVat()


    public
                    setUseVat(bool $useVat) : $this

Parameters

$useVat : bool

Return values

$this

setVariableSymbol()


    public
                    setVariableSymbol(string|null $variableSymbol) : $this

Parameters

$variableSymbol : string|null

Return values

$this

setVouchers()


    public
                    setVouchers(Collection<int, TVoucher>|array<int, TVoucher> $vouchers) : $this

Parameters

$vouchers : Collection<int, TVoucher>|array<int, TVoucher>

Return values

$this

shipperCollectionInit()


    public
                    shipperCollectionInit() : void

voucherCollectionInit()


    public
                    voucherCollectionInit() : void

getTraitsRecursive()

Walks the trait list recursively and collects nested traits too.


    private
            static        getTraitsRecursive(array<string, string> $traits) : array<string, string>

Parameters

$traits : array<string, string>

Return values

array<string, string>

Invoice extends BaseEntity in package Application implements IdentifiableInterface uses IdentifiableTrait, TaxSnapshotTrait, ItemCollectionTrait, GiftCollectionTrait, VoucherCollectionTrait, ShipperCollectionTrait, PaymentMethodCollectionTrait

Tags

Attributes

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

LOCK_REASON_CREDIT_NOTE

LOCK_REASON_EMAIL

LOCK_REASON_MANUAL

Properties

$bankAccount

Attributes

$bankName

Attributes

$billingLineId

Attributes

$constantSymbol

Attributes

$creationDate

Attributes

$currencyId

Attributes

$customerCity

Attributes

$customerContactId

Attributes

$customerContactId2

Attributes

$customerCountry

Attributes

$customerCountryCode

Attributes

$customerDlvCity

Attributes

$customerDlvCountry

Attributes

$customerDlvCountryCode

Attributes

$customerDlvInformations

Attributes

$customerDlvName

Attributes

$customerDlvName2

Attributes

$customerDlvPostcode

Attributes

$customerDlvStreet

Attributes

$customerEmail

Attributes

$customerId

Attributes

$customerId2

Attributes

$customerInformations

Attributes

$customerName

Attributes

$customerName2

Attributes

$customerPhone

Attributes

$customerPostcode

Attributes

$customerRegNo

Attributes

$customerStreet

Attributes

$customerVatId

Attributes

$customerVatIdCheckId

Attributes

$customerVatIdOutageCheckId

Attributes

$customerVatIdVerified

Attributes

$customerVatIdVerifiedAt

Invoice extends BaseEntity
in package

Application

implements IdentifiableInterface uses IdentifiableTrait, TaxSnapshotTrait, ItemCollectionTrait, GiftCollectionTrait, VoucherCollectionTrait, ShipperCollectionTrait, PaymentMethodCollectionTrait