CoolCMS API

DTO

Table of Contents

Classes

CronJobCallResult
Outcome of one HTTP call of a cron job; `response` is shortened and never contains the token.
CronJobDefinition
One job of the scheduler catalog, read from the {@see \App\Core\Attributes\Cron\CronJob} attribute.
SellerTaxProfile
Tax profile of a seller on a date, read through a single place ({@see \App\UI\Api\System\Models\Managers\SellerTaxProfileManager}).
TaxAncillaryShare
Part of an ancillary supply (gateway fee, shipping) allocated to one group code × rate.
TaxContext
Input of {@see \App\UI\Api\System\Models\Managers\TaxManager::resolve()}.
TaxCountry
Raw country row the engine needs (`cms_system_countries`).
TaxLine
One line to resolve.
TaxLineResult
Resolved line: treatment + base. The engine does no line arithmetic except the gross price split: `grossPrice` line → `base = money(gross ÷ (1 + rate))`, `vat = gross − base`; base line → `base = amount`, `vat = null` (the consumer multiplies by the PD rounding rules).
TaxResolution
Result of {@see \App\UI\Api\System\Models\Managers\TaxManager::resolve()}.
TaxRuleRow
One decided row of the rule table (output of {@see \App\UI\Api\System\Models\Helpers\TaxRuleTable::decide()}).
TaxTreatment
Resolved treatment of one line (or the document header).
VatIdCheckAllowance
How many online VIES checks the caller has left. The UI hides the VAT id verification button when {@see canCheckOnline()} is false and may show {@see $resetsAt}.
VatIdCheckLimit
Rate limit the online VIES calls of one caller count against — built by {@see \App\UI\Api\System\Models\Managers\VatIdCheckManager::buildUserCheckLimit()} / {@see \App\UI\Api\System\Models\Managers\VatIdCheckManager::buildAutoCheckLimit()}.
VatIdVerification
Outcome of the VAT id policy for one resolution / verify call.
ViesResult
Answer of {@see \App\UI\Api\System\Models\Services\ViesClient::check()}.
On this page

Search results