CoolCMS API

__construct()

Parameters

$sellerId : int = 0

required; seller from the Invoicer directory. The composer builds the seller_* snapshot from it and an unknown id is a hard error (an invoice without a seller header must not reach the customer).

$currencyId : int = 0

required; invoice currency. Without it no payment QR code is generated and the PDF cannot format amounts.

$invoiceTypeId : int = 0

required; invoice type, the source of the PDF variant matrix and of a possible custom number line.

$customer : InvoiceComposerCustomer|null = null

customer; null means an invoice without a customer (internal or proforma print), accepted as a deliberate choice of the caller

$lines : array<int, InvoiceComposerLine> = []

billed lines; an empty array is an error (an invoice for zero with a number from a live line is always a caller mistake)

$billingLineId : int|null = null

billing line; null takes the line of the invoice type, then 7/invoice.default.billingLineId. It is mutually exclusive with $number, enforced by InvoiceManager::beforeSave(); the composer checks it earlier so that no PDF is wasted.

$number : string|null = null

manual number (import or migration); null lets the billing line generate it

$useVat : bool|null = null

IMPORTANT: fallback override of the VAT payer status without a justification; superseded by $taxOverride and kept only for existing callers. null takes the seller's tax status as of the tax point (SellerManager::resolveUseVatOn()). Ignored when $taxOverride is set.

$vatPercents : int|float|string|null = null

IMPORTANT: default rate for lines without a supply kind; null takes 7/invoice.default.vatPercents. A line with a supply kind does not use it, the engine decides the rate. Superseded by $taxOverride and the supply kind.

$supplyKindId : int|null = null

default supply kind of lines without their own; null leaves such lines without a kind and the engine is not called for them

$taxOverride : InvoiceTaxOverride|null = null

manual override of the tax treatment (code, rate and mandatory reason). It beats the engine result for the whole invoice, sets the MANUAL_OVERRIDE flag and stores the reason in tax_override_reason. The only way to get DOMESTIC_REVERSE_CHARGE.

$supplyPlaceCountryCode : string|null = null

ISO2 country of the place of supply (where the property is); read only for supply kinds with the immovable_service nature

$customerIsBusiness : bool|null = null

null derives it from the customer's registration and VAT numbers; true forces the business class (a non-EU company confirmed by the admin)

$defaultUnit : string|null = null

default unit of lines without their own; null takes 7/invoice.default.unit

$sellerContactId : int|null = null

specific seller contact; null takes 7/invoice.default.sellerContactId, then the seller's first contact

$sellerBankAccountId : int|null = null

specific seller bank account; null takes 7/invoice.default.sellerBankAccountId, then the seller's first account

$productTypeId : int|null = null

axis of the PDF variant matrix; null takes 7/invoice.default.productTypeId

$userTypeId : int|null = null

axis of the PDF variant matrix; null takes 7/invoice.default.userTypeId, then the customer contact

$paymentRegionId : int|null = null

axis of the PDF variant matrix; null takes 7/invoice.default.paymentRegionId, then the default region. Never null on the invoice: without a region the matrix finds no variant and the invoice would have no PDF.

$languageId : int|null = null

invoice language; null takes the customer's language, then the default language of the payment region, then 7/invoice.default.languageId, then 1

$creationDate : DateTime|null = null

issue date (also drives %Y and %m in the number mask and the sequence period_key); null means today

$taxableSupplyDate : DateTime|null = null

tax point; null equals the issue date

$dueDate : DateTime|null = null

due date; null means the issue date plus $duePeriod

$duePeriod : int|null = null

days until due when $dueDate is not set; null takes 7/invoice.default.duePeriod, then 14

$status : string = 'unpaid'

payment status (unpaid or paid); an invoice is issued as unpaid

$variableSymbol : string|null = null

null derives it from the invoice number (digits)

$informations : string|null = null

note printed on the invoice

$sendEmail : bool = false

"send by e-mail" flag; the composer sends nothing, it only records the intent

$emailTo : string|null = null

recipient; null with $sendEmail means the customer's e-mail

$pdfTemplateVariantId : int|null = null

hard-chosen PDF variant; null uses the matrix of the invoice type