CoolCMS API

Entities

Table of Contents

Classes

BillingLine
BillingLineText
Customer
Customer of an invoice (`cms_mod_invoicer_customers`): `name` plus an owned collection of contacts (multiplier, full-replace object-graph save). Also used in picker mode by the invoice form.
CustomerContact
Customer contact (`cms_mod_invoicer_customer_contacts`), owned collection `Customer.contacts` (cascade persist/remove).
Invoice
Invoice (`cms_mod_invoicer_invoices`): header (number, dates, payment, e-mail) plus owned collections of lines (full-replace object-graph save).
InvoiceGift
Invoice gift, owned collection `Invoice.gifts` (cascade persist/remove).
InvoiceItem
Invoice line, owned collection `Invoice.items` (cascade persist/remove).
InvoicePaymentMethod
Invoice payment method, owned collection `Invoice.paymentMethods` (one row, fixed block).
InvoiceShipper
Invoice shipper, owned collection `Invoice.shippers` (one row, fixed block).
InvoiceTemplate
Invoice template (`cms_mod_invoicer_invoice_templates`): header plus owned collections of lines (items, gifts, vouchers, shipper, payment method; full-replace object-graph save).
InvoiceTemplateGift
Invoice template gift, owned collection `InvoiceTemplate.gifts` (cascade persist/remove).
InvoiceTemplateItem
Invoice template line, owned collection `InvoiceTemplate.items` (cascade persist/remove).
InvoiceTemplatePaymentMethod
Invoice template payment method, owned collection `InvoiceTemplate.paymentMethods` (one row, fixed block).
InvoiceTemplateShipper
Invoice template shipper, owned collection `InvoiceTemplate.shippers` (one row, fixed block).
InvoiceTemplateVoucher
Invoice template voucher, owned collection `InvoiceTemplate.vouchers` (cascade persist/remove).
InvoiceType
InvoiceTypePdfTemplateVariantRel
Matice PDF variant InvoiceType×ProductType×PaymentRegion×BuyerVatType×SellerUseVat — owned collection (`InvoiceType.pdfTemplateVariantRels`, full-replace object-graph save).
InvoiceTypePdfVariantTreatmentRel
Matrix of PDF variants by invoice type x VAT treatment code, owned collection `InvoiceType.pdfVariantTreatmentRels` saved by full-replace object-graph save in one save of the invoice type.
InvoiceTypeText
InvoiceVoucher
Invoice voucher, owned collection `Invoice.vouchers` (cascade persist/remove).
PaymentMethod
PaymentMethodText
PaymentStatusRule
Mapping of payment status to invoice type (settings form, section of invoices by payment status).
ProductType
ProductTypeText
Schedule
Schedule of periodic invoice generation. No owned collections; the scalar fields are inherited from {@see BaseSchedule} (`name`, `renewalPeriod`, `interval`, `renewalDate`, `endDate`, `active`, `generateFrom` plus the FKs `invoiceTemplateId` and `invoiceId`).
Seller
Seller (`cms_mod_invoicer_sellers`): `name`, `countryCode` plus owned collections of contacts (without `userType`), bank accounts and VAT status history (multiplier, full-replace object-graph save).
SellerBankAccount
Seller bank account (`cms_mod_invoicer_seller_bank_accounts`), owned collection `Seller.bankAccounts` (cascade persist/remove).
SellerContact
Seller contact (`cms_mod_invoicer_seller_contacts`), owned collection `Seller.contacts` (cascade persist/remove).
SellerTaxStatus
VAT status history row of a seller — owned collection `Seller.taxStatuses` (cascade persist/remove), edited in the seller form (tax status fieldset).
On this page

Search results