documents
Table of Contents
Namespaces
- export
Classes
- Adjustment
- A price adjustment applied on a {@see BusinessDocumentLine} or on a whole
{@see BusinessDocument} — inspired by UBL's `AllowanceCharge`.
- AgingSummary
- The accounts-receivable aging breakdown of a {@see Statement} : how much of
the outstanding balance is still current versus overdue, split into the
industry-standard buckets (current, 1–30, 31–60, 61–90, over 90 days).
- AppliedEcoFee
- The record of an {@see EcoFeeRule} applied on a {@see BusinessDocumentLine},
with the resulting amount — the audit trail answering *which rule, at what
quantity, produced this fee*.
- BusinessDocument
- The common parent of the quote → purchase order → invoice cycle (and its
neighbors: credit note, delivery note, receipt, statement).
- BusinessDocumentLine
- A single line of a {@see BusinessDocument} : the item sold, its quantity
and price, the taxes and adjustments applying to it, and the resulting
line totals.
- CreditNote
- A credit note (avoir) — corrects or cancels all or part of an {@see Invoice}
already issued.
- DebitNote
- A debit note — the symmetric inverse of a {@see CreditNote} : it *increases*
what a customer owes, correcting an {@see Invoice} that was billed too low
(an under-charge, a forgotten line, an after-the-fact surcharge).
- DeliveryLine
- A single line of a {@see DeliveryNote} : how much of a given
{@see BusinessDocumentLine} (identified by `position`) was actually
delivered, as opposed to ordered or left in backorder.
- DeliveryNote
- A delivery note (bon de livraison) — attests the physical delivery of the
goods of a {@see PurchaseOrder}.
- DocumentTotals
- The monetary summary of a {@see BusinessDocument} : total excluding tax,
total tax, total including tax, amount already prepaid and balance due,
plus the optional document-level allowance (discount) and charge totals.
- EcoFeeRule
- The calculation rule behind an environmental contribution (eco-fee) — e.g.
- GoodsReceiptConfirmation
- A goods-receipt confirmation — the buyer confirms having received the goods
of a {@see DeliveryNote}, reporting per-line the quantity actually received
and any discrepancy or damage.
- GoodsReceiptLine
- A single line of a {@see GoodsReceiptConfirmation} : how much of a given
{@see DeliveryLine} (by `position`) the buyer actually received, versus what
the delivery announced — the buyer-side counterpart of {@see DeliveryLine}.
- Invoice
- An invoice — the final billing document of the quote → purchase order →
invoice cycle, issued once the goods or services have been delivered.
- PaymentInstallment
- A single scheduled payment within a {@see PaymentSchedule}.
- PaymentReminder
- The record of a payment reminder sent to (or planned for) the customer
about an unpaid {@see PaymentInstallment} or {@see BusinessDocument}.
- PaymentSchedule
- A multi-installment payment plan attached to a {@see BusinessDocument}
(e.g. "30% on order, 70% on delivery").
- ProofOfDelivery
- The confirmation that the goods of a {@see DeliveryNote} were received —
who signed for them, when, and any discrepancy noted at that moment
between what was delivered and what the recipient actually confirmed.
- PurchaseOrder
- A purchase order — the customer's confirmed commitment to buy, typically
following the acceptance of a {@see Quote}.
- Quote
- A quote (estimate) offered to a customer ahead of an order.
- Receipt
- A receipt (reçu) — proof that a payment was received.
- RemittanceAdvice
- A remittance advice — the document a *payer* sends to the payee to detail a
payment being (or about to be) made : which invoices it settles and the
total amount remitted.
- Statement
- A statement (relevé de compte) — a periodic recap of the documents that
moved an account's balance (quotes turned into orders, invoices, credit
notes, receipts…), with an opening and a closing balance.
- StatementEntry
- A single line of a {@see Statement} : a document that moved the account's
balance (a `Quote`, `PurchaseOrder`, `Invoice`, `CreditNote`, `Receipt`…),
its amount, and the running balance after applying it.
- TaxDetail
- A single tax or environmental-contribution line applied on a
{@see BusinessDocumentLine} or on a whole {@see BusinessDocument}.
