@aptos-scp/scp-component-store-selling-features-domain-model 1.0.0

package/lib/domain/model/MerchandiseTransaction.d.ts

@@ -0,0 +1,310 @@
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { DeviceIdentity, ITransaction, ITransactionLine, ITransactionLineFactory, IUser } from "@aptos-scp/scp-component-store-selling-core";
+import { IBaseTransactionTaxCalculationResults } from "@aptos-scp/scp-component-taxation";
+import { IFiscalSignature, ITaxByTaxAuthority, ITaxByTaxRule, ITaxOverride, MerchandiseTransactionReservationStatus, MerchandiseTransactionTradeType, TaxCalculationSystem } from "@aptos-scp/scp-types-commerce-transaction";
+import { GiftReceiptMode } from "./Constants";
+import { Coupon } from "./Coupon";
+import { Customer } from "./Customer";
+import { IEmployee } from "./Employee";
+import { Order } from "./Order";
+import { RetailTransaction } from "./RetailTransaction";
+import { ITransactionReferenceFormatter } from "../service";
+import { TaxCustomerLine } from "./customer/TaxCustomerLine";
+import { IFiscalTransactionNumberMaintainer } from "./IFiscalTransactionNumberMaintainer";
+import { IInvoiceOperation } from "./IInvoiceOperation";
+import { IPrepaidTenderToApply } from "./PrepaidTender";
+export declare const MERCHANDISE_TRANSACTION_TYPE = "MerchandiseTransaction";
+export declare const isMerchandiseTransaction: (transaction: ITransaction) => transaction is MerchandiseTransaction;
+export interface CustomFeeTotal {
+    feeId: string;
+    feeType: string;
+    description: string;
+    amount: Money;
+}
+export interface TotalsBeforeVoid {
+    transactionTotalSavings: Money;
+    transactionSubTotal: Money;
+    transactionSubTotalExcludingTax?: Money;
+    transactionOrderGrandTotal?: Money;
+    transactionSubTotalIncludingTax?: Money;
+    transactionTax: Money;
+    transactionTotalTransactionDiscounts: Money;
+    transactionSubTotalExcludingTransactionDiscounts: Money;
+    transactionTotal: Money;
+    transactionTotalExcludingTax: Money;
+    transactionTotalTendered: Money;
+    transactionTotalTenderedExcludingPreviouslyCollected: Money;
+    transactionTotalPreviouslyCollectedTenders: Money;
+    transactionTotalTenderedOnOrderCreate: Money;
+    transactionNonTaxableFee?: Money;
+    transactionFeeExcludingTax?: Money;
+    transactionFeeTax?: Money;
+    transactionTotalFee: Money;
+    transactionTaxableAmount: Money;
+    transactionTaxExemptAmount?: Money;
+    transactionTotalDeliveryFee?: Money;
+    transactionTotalBagFee?: Money;
+    transactionTotalPublicImprovementFee?: Money;
+    transactionTotalCustomFeeByType?: CustomFeeTotal[];
+    transactionTotalShippingFee?: Money;
+    transactionTotalDonations?: Money;
+    transactionSubTotalExcludingPreviouslyCollectedExcludingTax?: Money;
+    transactionTaxAdjustmentAmount?: Money;
+    transactionSubTotalAfterTaxAdjustment?: Money;
+    transactionTotalFeeAfterTaxAdjustment?: Money;
+}
+export interface GovernmentBusinessId {
+    type?: string;
+    id?: string;
+    prefix?: string;
+    issueDate?: string;
+    expirationDate?: string;
+}
+export interface IAppTransactionTaxes extends IBaseTransactionTaxCalculationResults {
+    taxAuthorities: ITaxByTaxAuthority[];
+    taxExemptDisplayName?: string;
+    taxOverride?: ITaxOverride;
+    preTaxOverrideDetails?: ITaxByTaxRule[];
+    taxCalculationSystem?: TaxCalculationSystem;
+    taxCalculationSystemReason?: string;
+}
+export declare class MerchandiseTransaction extends RetailTransaction implements IInvoiceOperation, IFiscalTransactionNumberMaintainer {
+    private _accountingCurrency;
+    private _transactionSubTotal;
+    private _transactionSubTotalExcludingTax?;
+    private _transactionSubTotalIncludingTax?;
+    private _transactionOrderGrandTotal?;
+    private _transactionTax;
+    private _transactionTaxableAmount;
+    private _transactionSubTotalExcludingTransactionDiscounts;
+    private _transactionLevelSavings?;
+    private _transactionTaxes;
+    private _transactionTotalSavings;
+    private _transactionTotalTransactionDiscounts;
+    private _transactionTotalTendered;
+    private _transactionTotalTenderedPreviouslyCollected;
+    private _transactionTotalTenderedExcludingPreviouslyCollected;
+    private _transactionTotalPreviouslyCollectedTenders;
+    private _transactionTotalTenderedOnOrderCreate;
+    private _transactionTotalChangeTendered;
+    private _transactionNonTaxableFee;
+    private _transactionTotalDonations;
+    private _transactionFeeExcludingTax?;
+    private _transactionFeeTax?;
+    private _transactionTotalFee;
+    private _transactionTotalDeliveryFee;
+    private _transactionTotalBagFee;
+    private _transactionTotalPublicImprovementFee;
+    private _transactionTotalCustomFeeByType;
+    private _transactionTotalShippingFee;
+    private _returnSubTotal;
+    private _returnSubTotalExcludingTax?;
+    private _returnSubTotalIncludingTax?;
+    private _returnTax;
+    private _returnTotalSavings;
+    private _saleTotalQuantity;
+    private _returnTotalQuantity;
+    private _customer;
+    private _taxCustomer;
+    private _transactionTradeType;
+    private _shouldUpdatePricing;
+    private _shouldUpdateTaxation;
+    private _referenceNumber;
+    private _giftReceipt;
+    private _giftReceiptMode;
+    private _salesperson;
+    private _transactionReferenceFormatter;
+    private _totalsBeforeVoid;
+    private _unusedCoupons?;
+    private _employeeCustomer;
+    private _governmentIssuedIds;
+    private _invoiceNumber?;
+    private _invoiceSequenceNumber?;
+    private _invoiceSequenceNumberGenerator?;
+    private _transactionTaxExemptAmount?;
+    private _transactionTaxAdjustmentAmount?;
+    private _transactionSubTotalAfterTaxAdjustment?;
+    private _transactionTotalFeeAfterTaxAdjustment?;
+    private _tradeType?;
+    private _taxLotteryNumber?;
+    private _denominationRounding?;
+    private _order?;
+    private _orderReferenceSequenceNumber?;
+    private _orderReferenceSequenceNumberGenerator?;
+    private _taxLotteryCustomerCode?;
+    private _fiscalSignature;
+    private _requiresVoid;
+    private _fiscalTransactionNumber?;
+    private _fiscalTypeCode?;
+    private _fiscalTransactionSequenceNumber?;
+    private _fiscalTransactionSequenceNumberGenerator?;
+    private _invoiceFiscalTransactionNumber?;
+    private _invoiceTransactionNumber?;
+    private _taxScanCodeData?;
+    private _eInvoiceReference?;
+    private _digestValue?;
+    private _prepaidTendersToApply?;
+    private _transactionSubTotalExcludingPreviouslyCollected;
+    private _transactionTotalSavingsExcludingPreviouslyCollected;
+    private _transactionTotalTaxExcludingPreviouslyCollected;
+    private _balanceDueExcludingPreviouslyCollected;
+    private _transactionTotalExcludingPreviouslyCollected;
+    private _transactionSubTotalExcludingPreviouslyCollectedExcludingTax;
+    static createFromJsonObj(transactionJsonObj: any, transactionLineFactory: ITransactionLineFactory, transactionReferenceFormatter: ITransactionReferenceFormatter): MerchandiseTransaction;
+    constructor(deviceIdentity: DeviceIdentity, businessDayDate: string, transactionNumber: number, accountingCurrency: string, transactionReferenceFormatter: ITransactionReferenceFormatter, governmentIssuedIds?: GovernmentBusinessId[], performingUser?: IUser, transactionId?: string, giftReceiptMode?: GiftReceiptMode, giftReceipt?: boolean, totalsBeforeVoid?: TotalsBeforeVoid, unusedCoupons?: Coupon[], employeeCustomer?: IEmployee, invoiceNumber?: string, invoiceSequenceNumber?: number, taxLotteryNumber?: string, order?: Order, invoiceSequenceNumberGenerator?: string, taxLotteryCustomerCode?: string, taxScanCodeData?: string, fiscalSignature?: IFiscalSignature, requiresVoid?: boolean, eInvoiceReference?: string, prepaidTendersToApply?: IPrepaidTenderToApply[], digestValue?: string);
+    clone(): ITransaction;
+    addLine(line: ITransactionLine): ITransaction;
+    createOrUpdateOrder(order: Order): ITransaction;
+    removeOrder(): ITransaction;
+    voidOrder(): ITransaction;
+    assignPrepaidTendersToApply(prepaidTendersToApply: IPrepaidTenderToApply[]): ITransaction;
+    removeAppliedPrepaidTender(prepaidTender: IPrepaidTenderToApply): ITransaction;
+    get accountingCurrency(): string;
+    get transactionSubTotal(): Money;
+    get transactionSubTotalAfterTaxAdjustment(): Money;
+    get transactionTotalFeeAfterTaxAdjustment(): Money;
+    get transactionSubTotalExcludingTax(): Money;
+    get transactionSubTotalIncludingTax(): Money;
+    /**
+     * Total order items with shipping, including subscriptions and send sale
+     */
+    get transactionOrderGrandTotal(): Money;
+    get transactionTax(): Money;
+    get transactionTotalExcludingTax(): Money;
+    get transactionTaxableAmount(): Money;
+    get transactionSubTotalExcludingTransactionDiscounts(): Money;
+    get transactionLevelSavings(): Money;
+    get transactionTaxes(): IAppTransactionTaxes[];
+    get transactionTaxesBeforeVoid(): IAppTransactionTaxes[];
+    get transactionTotalSavings(): Money;
+    get transactionTotalTransactionDiscounts(): Money;
+    get transactionTotalTendered(): Money;
+    get transactionTotalTenderedPreviouslyCollected(): Money;
+    /**
+     * Transaction SubTotal excluding previously collected tendered amount and excluding tax
+     */
+    get transactionSubTotalExcludingPreviouslyCollectedExcludingTax(): Money;
+    /**
+     * Total amount of tender applied to this transaction excluding previously collected tendered amount applied to this transaction
+     */
+    get transactionTotalTenderedExcludingPreviouslyCollected(): Money;
+    /**
+     *  Total previously collected ammount applied to this transaction (transferfromaccount)
+     */
+    get transactionTotalPreviouslyCollectedTenders(): Money;
+    /**
+     *  Total tendered amount for the order on creation (order items, order fees..)
+     */
+    get transactionTotalTenderedOnOrderCreate(): Money;
+    get transactionTotalChangeTendered(): Money;
+    get transactionNonTaxableFee(): Money;
+    get transactionTotalDonations(): Money;
+    get transactionFeeExcludingTax(): Money;
+    get transactionFeeTax(): Money;
+    get transactionTotalFee(): Money;
+    get transactionTotalDeliveryFee(): Money;
+    get transactionTotalBagFee(): Money;
+    get transactionTotalPublicImprovementFee(): Money;
+    get transactionTotalCustomFeeByType(): CustomFeeTotal[];
+    get transactionTotalShippingFee(): Money;
+    get returnSubTotal(): Money;
+    get returnSubTotalExcludingTax(): Money;
+    get returnSubTotalIncludingTax(): Money;
+    get returnTax(): Money;
+    get returnTotalSavings(): Money;
+    get transactionSubTotalExcludingPreviouslyCollected(): Money;
+    get transactionTotalSavingsExcludingPreviouslyCollected(): Money;
+    get transactionTotalTaxExcludingPreviouslyCollected(): Money;
+    get saleTotalQuantity(): number;
+    get returnTotalQuantity(): number;
+    get transactionTotalsBeforeVoid(): TotalsBeforeVoid;
+    get customer(): Customer;
+    get taxCustomer(): TaxCustomerLine;
+    get transactionTradeType(): MerchandiseTransactionTradeType;
+    get employeeCustomer(): IEmployee;
+    get referenceNumber(): string;
+    get unusedCoupons(): Coupon[];
+    get governmentIssuedIds(): GovernmentBusinessId[];
+    get invoiceNumber(): string;
+    get orderReferenceNumber(): string;
+    get invoiceSequenceNumber(): number;
+    get invoiceSequenceNumberGenerator(): string;
+    get orderReferenceSequenceNumber(): number;
+    get orderReferenceSequenceNumberGenerator(): string;
+    get transactionTaxExemptAmount(): Money;
+    get transactionTaxAdjustmentAmount(): Money;
+    get tradeType(): MerchandiseTransactionTradeType;
+    get taxLotteryNumber(): string;
+    get taxLotteryCustomerCode(): string;
+    get taxScanCodeData(): string;
+    get signatureCollected(): boolean;
+    get itemPickupSignatureCollected(): boolean;
+    get isPickingUpItems(): boolean;
+    get denominationRounding(): Money;
+    get order(): Order;
+    get prepaidTendersToApply(): IPrepaidTenderToApply[];
+    get inventoryReservationStatus(): MerchandiseTransactionReservationStatus;
+    get fiscalSignature(): IFiscalSignature;
+    get requiresVoid(): boolean;
+    get fiscalTransactionNumber(): string;
+    get fiscalTypeCode(): string;
+    get fiscalTransactionSequenceNumber(): number;
+    get fiscalTransactionSequenceNumberGenerator(): string;
+    get invoiceFiscalTransactionNumber(): string;
+    get invoiceTransactionNumber(): number;
+    get eInvoiceReference(): string;
+    get digestValue(): string;
+    updateUnusedCoupons(unusedCoupons: Coupon[]): ITransaction;
+    updateGovernmentIssuedIds(governmentIssuedIds: GovernmentBusinessId[]): ITransaction;
+    assignCustomer(customer: Customer): ITransaction;
+    assignTaxCustomer(taxCustomer: TaxCustomerLine): ITransaction;
+    assignTradeType(transactionTradeType: MerchandiseTransactionTradeType): ITransaction;
+    removeCustomer(): ITransaction;
+    updateGiftReceiptMode(giftReceiptMode: GiftReceiptMode): ITransaction;
+    updateGiftReceipt(giftReceipt: boolean, giftReceiptMode?: GiftReceiptMode): ITransaction;
+    get salesperson(): IEmployee;
+    updateTransactionTotalsBeforeVoid(totalsBeforeVoid: TotalsBeforeVoid): ITransaction;
+    assignSalesperson(salesperson: IEmployee): ITransaction;
+    removeSalesperson(): ITransaction;
+    assignEmployeeCustomer(employeeCustomer: IEmployee): ITransaction;
+    removeEmployeeCustomer(): ITransaction;
+    assignInvoiceNumber(invoiceNumber: string): ITransaction;
+    assignInvoiceSequenceNumber(invoiceSequenceNumber: number, invoiceSequenceNumberGenerator: string): ITransaction;
+    assignFiscalTransactionNumber(fiscalTransactionNumber: string): ITransaction;
+    assignFiscalTypeCode(fiscalTypeCode: string): ITransaction;
+    assignFiscalTransactionSequenceNumber(fiscalTransactionSequenceNumber: number, fiscalTransactionSequenceNumberGenerator: string): ITransaction;
+    assignOrderReferenceSequenceNumber(orderReferenceSequenceNumber: number, orderReferenceSequenceNumberGenerator: string): ITransaction;
+    assignInvoiceFiscalTransactionNumber(invoiceTransactionNumber: number, invoiceFiscalTransactionNumber: string): ITransaction;
+    assignTaxlotteryNumber(taxLotteryNumber: string): ITransaction;
+    assignCustomerLotteryCode(taxLotteryCustomerCode: string): ITransaction;
+    removeCustomerLotteryCode(): ITransaction;
+    assignTaxScanCodeData(taxScanCodeData: string): ITransaction;
+    assignFiscalSignature(signatureData: IFiscalSignature): ITransaction;
+    assignDigestValue(digestValue: string): ITransaction;
+    assignEInvoiceReference(eInvoiceReference: string): ITransaction;
+    setFatalVoidableError(): ITransaction;
+    get shouldUpdatePricing(): boolean;
+    get shouldUpdateTaxation(): boolean;
+    get giftReceiptMode(): GiftReceiptMode;
+    get giftReceipt(): boolean;
+    get transactionTotal(): Money;
+    get transactionTotalExcludingPreviouslyCollected(): Money;
+    get transactionBalanceDue(): Money;
+    get transactionBalanceDueExcludingPreviouslyCollected(): Money;
+    get transactionChangeDue(): Money;
+    get returnTotal(): Money;
+    get transactionStateValues(): Readonly<Map<string, any>>;
+    toJSON(): object;
+    protected newTransaction(): RetailTransaction;
+    protected loadFromJsonObject(transactionJsonObj: any, transactionLineFactory: ITransactionLineFactory): void;
+    private getTotalsBeforeVoid;
+    private taxIncludedInPrice;
+    private convertAmountToAccountingCurrency;
+    private getTransactionTotal;
+    private getTransactionBalanceDue;
+    private generateTransactionReferenceNumber;
+    private findSignatureLine;
+    private findItemPickupSignatureLine;
+    private findItemPickupLine;
+    private isPartialReserve;
+}