@dodobrands/pos-receipts-plugin-contracts 5.12.8

package/dist/index.d.ts

@@ -0,0 +1,445 @@
+import { Business, Country, ILogger } from '@dodobrands/pos-plugins-shared-models';
+export { Business, Country, CountryIsoCode } from '@dodobrands/pos-plugins-shared-models';
+
+type Money = {
+    amount: number;
+};
+
+/** Information that is required to correctly deposit cash to the register. */
+interface DepositCashOptions {
+    cash: Money;
+    cashierName?: string;
+}
+
+/** Information that is required to correctly withdraw cash from the register. */
+interface WithdrawCashOptions {
+    cash: Money;
+    cashierName?: string;
+}
+
+interface Taxpayer {
+    /** A tax identification number. It is used for value added tax purposes.
+     * The formal name may differ from country to country: It could be NIP for Poland, INN for Russia, or VAT number.
+     * https://en.wikipedia.org/wiki/VAT_identification_number */
+    IdentificationNumber: string | null;
+}
+
+/** The information about organization */
+interface OrganizationInfo {
+    /** The name of organization */
+    name?: string;
+    /** Taxpayer information */
+    taxpayer?: Taxpayer;
+    /** The physical address where organization has been registered  */
+    registeredAddress?: string;
+}
+
+interface CashRegisterSettings {
+    /** if a flag is not defined, it means it's false */
+    canHandleAlreadyHandledSale?: true;
+    /** The information about organization which was set in device */
+    organizationInfo?: OrganizationInfo;
+    /** Any data about the device in key-value form */
+    deviceInfo?: {
+        [key: string]: string;
+    };
+}
+
+type ProductSpecificData = UzbekistanProductData | KazakhstanProductData | null;
+interface UzbekistanProductData {
+    /** Identification code of products and services for Uzbekistan */
+    ikpu: string;
+    /** 0 - resail; 1 - own production; 2 - service */
+    ownerType?: OwnerType;
+    /** code of measurement type */
+    units: string;
+    /** related with ikpu */
+    barcode: string;
+}
+declare enum OwnerType {
+    Resail = 0,
+    OwnProduction = 1,
+    Service = 2
+}
+interface KazakhstanProductData {
+    /** Identification code of products */
+    gtin?: string;
+    ntin?: string;
+}
+
+/**
+ * Obsolete Receipt interface backward compatibility.
+ * Delete after moving all plugins to using new HandleRefundRequest and inner receipt property
+ */
+type HandleRefundRequest = HandleRefundRequestClear | Receipt;
+interface HandleRefundRequestClear {
+    receipt: Receipt;
+    printParams: PrintParams;
+}
+
+/**
+ * Obsolete Receipt interface backward compatibility.
+ * Delete after moving all plugins to using new HandleRefundRequest and inner receipt property
+ */
+type HandleSaleRequest = HandleSaleRequestClear | Receipt;
+interface HandleSaleRequestClear {
+    receipt: Receipt;
+    printParams: PrintParams;
+}
+
+interface InitializationOptions {
+    /** Known offset of the department where the store is. Offset **from UTC in minutes**.
+     * Can be used to identify which local time should be set on the particular machine.
+     * @example -120, 0, 1280
+     * */
+    departmentUtcOffsetMinutes: number;
+    /** Business is the name of the business/franchise we work with. E.g. Dodo Pizza, Doner 42, Drinkit */
+    business: Business;
+    country: Country;
+    cashboxId: string;
+    /** Determines should plugin handle sale with paper receipt or not. */
+    isPrintingPaperReceiptsDisabled: boolean;
+    infrastructure: {
+        logger?: ILogger;
+    };
+}
+
+/** Information which may be required to make Z-report. */
+interface MakeZReportOptions {
+    cashierName?: string;
+    withoutPaper?: boolean;
+}
+
+interface IDigitalReceipt {
+    views: DigitalReceiptView[];
+    fields?: Fields;
+    version: 'v1';
+}
+type DigitalReceiptViewType = 'mobile' | 'email' | 'link' | 'pos';
+type DigitalReceiptView = {
+    type: DigitalReceiptViewType;
+    data: string;
+};
+type Fields = {
+    type: 'FPtr10';
+    fnNumber: string;
+    fiscalDocumentSign: string;
+    fiscalDocumentNumber: string;
+};
+
+/** Other types of receipts may appear here */
+type PrintedReceipt = PrintedFiscalReceipt | PrintedNonFiscalReceipt;
+interface PrintedFiscalReceipt {
+    /** Inner receipt ID from POS device */
+    id: string;
+    /** Type of printed receipt */
+    type: 'Fiscal';
+    /** Serialized (JSON) body of receipt. Optional */
+    body?: string;
+    /** Data that allows us to show digital representations of the receipt */
+    digitalReceipt?: IDigitalReceipt;
+}
+interface PrintedNonFiscalReceipt {
+    /** Type of printed receipt */
+    type: 'NonFiscal';
+    /** Data that allows us to show digital representations of the receipt */
+    digitalReceipt?: IDigitalReceipt;
+}
+
+interface PrintedRefundReceipt {
+    /** Inner receipt ID from POS device */
+    id: string;
+    /** Type of printed receipt */
+    type: 'Refund';
+    /** Serialized (JSON) body of receipt. Optional */
+    body?: string;
+    /** Data that allows us to show digital representations of the receipt */
+    digitalReceipt?: IDigitalReceipt;
+}
+
+/** Options that can be used to print any text. Input may differ from country and tenant. */
+interface PrintTextOptions {
+    /** Multi-lined text to show in the receipt or separately. */
+    data?: string[];
+}
+
+/**
+ * The interface for the primary thing to be implemented in a plugin
+ * please look for details in existing plugins
+ * note: should be default export
+ */
+interface ICashRegister {
+    /**
+     * Plugin initialization function (will be called right after plugin download/installation and every time on page reload/app start)
+     */
+    initialize?: (options: InitializationOptions) => Promise<void>;
+    /**
+     * Settings getter function (will be called after initialization finish))
+     */
+    getSettings: () => Promise<CashRegisterSettings>;
+    /**
+     * Sale handler
+     */
+    handleSale: (handleSaleRequest: HandleSaleRequest) => Promise<PrintedReceipt>;
+    /**
+     * Refund handler
+     */
+    handleRefund?: (handleRefundRequest: HandleRefundRequest) => Promise<PrintedRefundReceipt>;
+    /**
+     * Call for X-report (usually - statistics for the current time)
+     */
+    makeXReport?: () => Promise<void>;
+    /**
+     * Call for ending the cash shift (e.g. end of workday or schedule)
+     * (usually, also final report printed)
+     */
+    makeZReport?: (options: MakeZReportOptions) => Promise<void>;
+    /**
+     * Cash withdrawal handler
+     */
+    withdrawCash?: (options: WithdrawCashOptions) => Promise<void>;
+    /**
+     * Cash deposit handler
+     */
+    depositCash?: (options: DepositCashOptions) => Promise<void>;
+    /**
+     * Print any text, such as informational block, promo details or pos terminal slip.
+     * NOTE: implement this only if your country/business require printing terminal slips or info checks
+     */
+    printText?: (options: PrintTextOptions) => Promise<void>;
+}
+
+interface PrintParams {
+    /** Has true value when receipt was sent to plugin in background for building Digital version of receipt */
+    WithoutPaper: boolean;
+    DigitalReceiptNotificationPreference: DigitalReceiptNotificationPreference;
+}
+/** The way we can notify the client about the receipt for the accepted order. */
+declare enum DigitalReceiptNotificationPreference {
+    /** Client did not specify how they want to receive digital receipt. Default value. Should be set as `NotSpecified` when the receipt is expected to be NOT digital. */
+    NotSpecified = "NotSpecified",
+    /** Client selected 'I don't want a receipt' */
+    None = "None",
+    /** Client selected 'I want the receipt on my email' */
+    Email = "Email",
+    /** Client selected 'I want the receipt link by phone via SMS' */
+    PhoneSms = "PhoneSms"
+}
+
+interface Receipt {
+    /** Order for this receipt */
+    Order: Order;
+    /** Customer information */
+    Customer: Customer;
+    /** Taxpayer information */
+    Taxpayer: Taxpayer;
+    /** Cash register from which the receipt is printed */
+    CashRegister: CashRegister;
+    /** Previous receipts that were printed for this order, including refunds */
+    PreviousReceipts: PreviousReceipt[];
+    /** Information about the organization that printed the receipt */
+    Organization: Organization;
+    /** Information about the store in which the purchase is occurring */
+    Store: Store;
+    /** Information needed for the loyalty program. */
+    Loyalty?: Loyalty;
+    /** Cash from the customer (if paid in cash) */
+    CashFromCustomer: number;
+    /** Information about the person taking the order. */
+    Cashier?: Cashier;
+    /** Url of the image to print on the receipt. */
+    Image?: Image;
+}
+interface Cashier {
+    /** Cashier name */
+    Name: string;
+    /** Cashier INN in russia and its analogues in other countries. */
+    TaxIdentificationNumber?: string;
+}
+interface Image {
+    /** Url of the image to print on the receipt. */
+    Url?: string;
+    /** Image data in base64 format. (ONLY FOR RUSSIA ATOL) */
+    Base64Data?: string;
+}
+interface Loyalty {
+    /** Customer Phone number */
+    PhoneNumber: string;
+    /** Amount of the bonus points awarded for the loyalty program. */
+    AwardedBonus: number;
+}
+interface Order {
+    /** Internal order identifier */
+    Id: string;
+    /** Order number seen by customers (e.g. "1-3") */
+    Number: string;
+    /** Current time in ISO 8601 format (e.g. "2021-04-30T10:50:00.0000000+04:00") */
+    CreateDate: string;
+    /** Products in cart */
+    Products: Product[];
+    Price: OrderPrice;
+    /**  @deprecated  Please switch to PaymentTypeEnum. */
+    PaymentType: 'Cash' | 'BankCard';
+    PaymentTypeEnum: PaymentType;
+    OrderSource: OrderSource;
+    /** Current time in ISO 8601 format (e.g. "2021-04-30T10:50:00.0000000+04:00") */
+    DeliveryDate?: string;
+    OrderType: OrderType;
+}
+declare enum OrderType {
+    Delivery = 1,
+    Pickup = 2,
+    Stationary = 3,
+    PersonalFood = 4,
+    ShopWindowSupply = 5
+}
+/** Shows the source from where the order has been taken. */
+declare enum OrderSource {
+    Telephone = 0,
+    Site = 1,
+    Restaurant = 2,
+    DefectOrder = 3,
+    Mobile = 4,
+    /** Shift manager order from call center. */
+    Pizzeria = 5,
+    Aggregator = 6,
+    Kiosk = 7
+}
+/** Shows how the order has been paid. Please expect frequent updates in the future. */
+declare enum PaymentType {
+    Cash = 0,
+    BankCard = 1,
+    InternetAcquiring = 2,
+    Aggregator = 3
+}
+interface OrderPrice {
+    /** The total price of the order (how much the customer actually paid) */
+    TotalPrice: number;
+    /** Total discount for the entire order (excluding discounts for individual products in the order) */
+    Discount: number;
+    /** Rounded cash amount the customer pays for an order (if paid in cash). Used only in countries with special rules for rounding cash */
+    RoundedCashAmount?: number;
+}
+interface Product {
+    /** Internal product identifier */
+    Id: string;
+    /** The product's name */
+    Name: string;
+    /** The quantity of this product in the order */
+    Quantity: number;
+    PricePerProduct: ProductPrice;
+    /** List of ingredients removed from the product */
+    RemovedIngredients: string[];
+    /** Additional ingredients added to the product */
+    AddedIngredients: AddedIngredient[];
+    /** The marking data used in some countries to pass scanned barcode value to the cash register. */
+    Marking?: MarkingCodes;
+    /** The product excise information */
+    Excise?: {
+        isExcise: boolean;
+    };
+    /** Additional data that can be defined for specific country */
+    CountrySpecific?: {
+        Uzbekistan?: UzbekistanProductData;
+        Kazakhstan?: KazakhstanProductData;
+    };
+}
+interface ProductPrice {
+    /** Price for 1 product excluding discount but with added ingredients */
+    Price: number;
+    /** Discount for 1 product (excluding the discount for the entire order) */
+    Discount: number;
+    Taxes: Tax[];
+}
+interface Tax {
+    /** Type of tax: value added or sales */
+    Type: 'VAT' | 'Sales' | 'Unknown';
+    /** Rate in percents */
+    Rate: number;
+}
+interface AddedIngredient {
+    /** Ingredient name */
+    Name: string;
+    /** The amount of ingredients added in portions */
+    Quantity: number;
+    /** Ingredient price added to the product */
+    Price: number;
+}
+interface Customer {
+    /** The name of the customer that he gave to the cashier */
+    Name: string;
+    /** Customer's mailing address, which he set in his personal account */
+    Email: string | null;
+    /** Any additional identifiers, e.g. customer's Tax Identification Number */
+    Identifiers: {
+        [index: string]: string;
+    };
+}
+interface CashRegister {
+    /** Internal cash register identifier */
+    UUId: string;
+    /**  */
+    Number: string;
+    /** To calculate or not to calculate VAT */
+    ShouldCalculateTax: boolean;
+}
+interface PreviousReceipt {
+    /** ID of the receipt returned by the POS printer. `null` if a print error has occurred. It is temporary field. Then it will be removed. Use `Identifier` instead of `Id` */
+    Id: number | null;
+    /** Printed receipt type: sales receipt or refund receipt */
+    Type: 'Sell' | 'Refund';
+    /** Date in format ISO 8601 (e.g. 2021-04-30T10:50:00.0000000+04:00) */
+    PrintDateTime: string;
+    /** ID of the receipt returned by the POS printer */
+    Identifier: string | null;
+    CashboxId: string;
+    /** Data returned by cash register after printing receipt */
+    CashRegisterOutput?: string;
+    /** Previous receipt payment type */
+    PaymentType: PaymentType;
+}
+interface Organization {
+    /** Full name of the organization */
+    Name: string;
+    /** Legal address */
+    Address: string;
+    /** Organization payment details */
+    Requisites: {
+        [index: string]: string;
+    };
+}
+interface Store {
+    /** Actual address */
+    Address: string;
+}
+type RussiaMarkingCode = {
+    /** Russian country iso code */
+    country: 643;
+    /** In Russia it's the string of digits, letters, special symbols and group separator. */
+    markingCode: string;
+};
+type BelarusMarkingCodes = {
+    /** Belarus country iso code */
+    country: 112;
+    /** Маркировка унифицированными контрольными знаками (УКЗ) */
+    ukzCode?: string;
+    /** Маркировка средствами идентификации (СИ) */
+    siCode?: string;
+    /** Маркировка с использованием штрихкода GTIN */
+    gtinCode?: string;
+};
+type ArmeniaMarkingCode = {
+    /** Armenia country iso code */
+    country: 51;
+    /** In Armenia it's the string of digits letters, special symbols and group separator. */
+    markingCode: string;
+};
+type UzbekistanMarkingCode = {
+    /** Uzbekistan country iso code */
+    country: 860;
+    /** In Uzbekistan it's the string of digits letters, special symbols and group separator. */
+    markingCode: string;
+};
+type MarkingCodes = RussiaMarkingCode | BelarusMarkingCodes | ArmeniaMarkingCode | UzbekistanMarkingCode | undefined;
+
+export { type AddedIngredient, type CashRegister, type CashRegisterSettings, type Cashier, type Customer, type DepositCashOptions, DigitalReceiptNotificationPreference, type DigitalReceiptView, type DigitalReceiptViewType, type Fields, type HandleRefundRequest, type HandleRefundRequestClear, type HandleSaleRequest, type HandleSaleRequestClear, type ICashRegister, type IDigitalReceipt, type Image, type InitializationOptions, type KazakhstanProductData, type Loyalty, type MakeZReportOptions, type MarkingCodes, type Money, type Order, type OrderPrice, OrderSource, OrderType, type Organization, OwnerType, PaymentType, type PreviousReceipt, type PrintParams, type PrintTextOptions, type PrintedFiscalReceipt, type PrintedNonFiscalReceipt, type PrintedReceipt, type PrintedRefundReceipt, type Product, type ProductPrice, type ProductSpecificData, type Receipt, type Store, type Tax, type Taxpayer, type UzbekistanProductData, type WithdrawCashOptions };

package/dist/index.js

@@ -0,0 +1,61 @@
+// ../../shared/pos-plugins-shared-models/dist/index.js
+var Business = /* @__PURE__ */ ((Business2) => {
+  Business2["DodoPizza"] = `dodoPizza`;
+  Business2["Drinkit"] = `drinkit`;
+  Business2["Doner42"] = `doner42`;
+  return Business2;
+})(Business || {});
+
+// src/CountrySpecificData.ts
+var OwnerType = /* @__PURE__ */ ((OwnerType2) => {
+  OwnerType2[OwnerType2["Resail"] = 0] = "Resail";
+  OwnerType2[OwnerType2["OwnProduction"] = 1] = "OwnProduction";
+  OwnerType2[OwnerType2["Service"] = 2] = "Service";
+  return OwnerType2;
+})(OwnerType || {});
+
+// src/PrintParams.ts
+var DigitalReceiptNotificationPreference = /* @__PURE__ */ ((DigitalReceiptNotificationPreference2) => {
+  DigitalReceiptNotificationPreference2["NotSpecified"] = `NotSpecified`;
+  DigitalReceiptNotificationPreference2["None"] = `None`;
+  DigitalReceiptNotificationPreference2["Email"] = `Email`;
+  DigitalReceiptNotificationPreference2["PhoneSms"] = `PhoneSms`;
+  return DigitalReceiptNotificationPreference2;
+})(DigitalReceiptNotificationPreference || {});
+
+// src/Receipt.ts
+var OrderType = /* @__PURE__ */ ((OrderType2) => {
+  OrderType2[OrderType2["Delivery"] = 1] = "Delivery";
+  OrderType2[OrderType2["Pickup"] = 2] = "Pickup";
+  OrderType2[OrderType2["Stationary"] = 3] = "Stationary";
+  OrderType2[OrderType2["PersonalFood"] = 4] = "PersonalFood";
+  OrderType2[OrderType2["ShopWindowSupply"] = 5] = "ShopWindowSupply";
+  return OrderType2;
+})(OrderType || {});
+var OrderSource = /* @__PURE__ */ ((OrderSource2) => {
+  OrderSource2[OrderSource2["Telephone"] = 0] = "Telephone";
+  OrderSource2[OrderSource2["Site"] = 1] = "Site";
+  OrderSource2[OrderSource2["Restaurant"] = 2] = "Restaurant";
+  OrderSource2[OrderSource2["DefectOrder"] = 3] = "DefectOrder";
+  OrderSource2[OrderSource2["Mobile"] = 4] = "Mobile";
+  OrderSource2[OrderSource2["Pizzeria"] = 5] = "Pizzeria";
+  OrderSource2[OrderSource2["Aggregator"] = 6] = "Aggregator";
+  OrderSource2[OrderSource2["Kiosk"] = 7] = "Kiosk";
+  return OrderSource2;
+})(OrderSource || {});
+var PaymentType = /* @__PURE__ */ ((PaymentType2) => {
+  PaymentType2[PaymentType2["Cash"] = 0] = "Cash";
+  PaymentType2[PaymentType2["BankCard"] = 1] = "BankCard";
+  PaymentType2[PaymentType2["InternetAcquiring"] = 2] = "InternetAcquiring";
+  PaymentType2[PaymentType2["Aggregator"] = 3] = "Aggregator";
+  return PaymentType2;
+})(PaymentType || {});
+export {
+  Business,
+  DigitalReceiptNotificationPreference,
+  OrderSource,
+  OrderType,
+  OwnerType,
+  PaymentType
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../shared/pos-plugins-shared-models/src/Business.ts","../../../shared/pos-plugins-shared-models/src/Country.ts","../src/CountrySpecificData.ts","../src/PrintParams.ts","../src/Receipt.ts"],"sourcesContent":["/**\n * Enum with supported business types.\n */\nexport enum Business {\n\t/**\n\t * Dodo Pizza business.\n\t */\n\tDodoPizza = `dodoPizza`,\n\t/**\n\t * Drinkit business.\n\t */\n\tDrinkit = `drinkit`,\n\t/**\n\t * Doner42 business.\n\t */\n\tDoner42 = `doner42`,\n}\n","/**\n * Country model\n */\nexport interface Country {\n\tcode: CountryIsoCode;\n}\n\n/** Country code based on [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_numeric)\n * @example 643, 705, 566\n */\nexport type CountryIsoCode = number;\n\nexport enum KnownCountryCodes {\n\tBelarus = 112,\n\tKazakhstan = 398,\n\tRussia = 643,\n\tUzbekistan = 860,\n}\n","export type ProductSpecificData = UzbekistanProductData | KazakhstanProductData | null;\n\nexport interface UzbekistanProductData {\n\t/** Identification code of products and services for Uzbekistan */\n\tikpu: string;\n\t/** 0 - resail; 1 - own production; 2 - service */\n\townerType?: OwnerType;\n\t/** code of measurement type */\n\tunits: string;\n\t/** related with ikpu */\n\tbarcode: string;\n}\n\nexport enum OwnerType {\n\tResail = 0,\n\tOwnProduction = 1,\n\tService = 2,\n}\n\nexport interface KazakhstanProductData {\n\t/** Identification code of products */\n\tgtin?: string;\n\tntin?: string;\n}\n","export interface PrintParams {\n\t/** Has true value when receipt was sent to plugin in background for building Digital version of receipt */\n\tWithoutPaper: boolean;\n\tDigitalReceiptNotificationPreference: DigitalReceiptNotificationPreference;\n}\n\n/** The way we can notify the client about the receipt for the accepted order. */\nexport enum DigitalReceiptNotificationPreference {\n\t/** Client did not specify how they want to receive digital receipt. Default value. Should be set as `NotSpecified` when the receipt is expected to be NOT digital. */\n\tNotSpecified = `NotSpecified`,\n\t/** Client selected 'I don't want a receipt' */\n\tNone = `None`,\n\t/** Client selected 'I want the receipt on my email' */\n\tEmail = `Email`,\n\t/** Client selected 'I want the receipt link by phone via SMS' */\n\tPhoneSms = `PhoneSms`,\n}\n","/* eslint-disable @typescript-eslint/no-magic-numbers */\nimport { type KazakhstanProductData, type UzbekistanProductData } from './CountrySpecificData';\nimport { type Taxpayer } from './Taxpayer';\n\nexport interface Receipt {\n\t/** Order for this receipt */\n\tOrder: Order;\n\t/** Customer information */\n\tCustomer: Customer;\n\t/** Taxpayer information */\n\tTaxpayer: Taxpayer;\n\t/** Cash register from which the receipt is printed */\n\tCashRegister: CashRegister;\n\t/** Previous receipts that were printed for this order, including refunds */\n\tPreviousReceipts: PreviousReceipt[];\n\t/** Information about the organization that printed the receipt */\n\tOrganization: Organization;\n\t/** Information about the store in which the purchase is occurring */\n\tStore: Store;\n\n\t/** Information needed for the loyalty program. */\n\tLoyalty?: Loyalty;\n\n\t/** Cash from the customer (if paid in cash) */\n\tCashFromCustomer: number;\n\n\t/** Information about the person taking the order. */\n\tCashier?: Cashier;\n\n\t/** Url of the image to print on the receipt. */\n\tImage?: Image;\n}\n\nexport interface Cashier {\n\t/** Cashier name */\n\tName: string;\n\n\t/** Cashier INN in russia and its analogues in other countries. */\n\tTaxIdentificationNumber?: string;\n}\n\nexport interface Image {\n\t/** Url of the image to print on the receipt. */\n\tUrl?: string;\n\n\t/** Image data in base64 format. (ONLY FOR RUSSIA ATOL) */\n\tBase64Data?: string;\n}\n\nexport interface Loyalty {\n\t/** Customer Phone number */\n\tPhoneNumber: string;\n\t/** Amount of the bonus points awarded for the loyalty program. */\n\tAwardedBonus: number;\n}\n\nexport interface Order {\n\t/** Internal order identifier */\n\tId: string;\n\t/** Order number seen by customers (e.g. \"1-3\") */\n\tNumber: string; // from OrderNumber\n\t/** Current time in ISO 8601 format (e.g. \"2021-04-30T10:50:00.0000000+04:00\") */\n\tCreateDate: string;\n\t/** Products in cart */\n\tProducts: Product[];\n\tPrice: OrderPrice;\n\t/**  @deprecated  Please switch to PaymentTypeEnum. */\n\tPaymentType: 'Cash' | 'BankCard';\n\tPaymentTypeEnum: PaymentType;\n\tOrderSource: OrderSource;\n\n\t/** Current time in ISO 8601 format (e.g. \"2021-04-30T10:50:00.0000000+04:00\") */\n\tDeliveryDate?: string;\n\tOrderType: OrderType;\n}\n\nexport enum OrderType {\n\tDelivery = 1,\n\tPickup = 2,\n\tStationary = 3,\n\tPersonalFood = 4,\n\tShopWindowSupply = 5,\n}\n\n/** Shows the source from where the order has been taken. */\nexport enum OrderSource {\n\tTelephone = 0,\n\tSite = 1,\n\tRestaurant = 2,\n\tDefectOrder = 3,\n\tMobile = 4,\n\t/** Shift manager order from call center. */\n\tPizzeria = 5,\n\tAggregator = 6,\n\tKiosk = 7,\n}\n\n/** Shows how the order has been paid. Please expect frequent updates in the future. */\nexport enum PaymentType {\n\tCash = 0,\n\tBankCard = 1,\n\tInternetAcquiring = 2,\n\tAggregator = 3,\n}\n\nexport interface OrderPrice {\n\t/** The total price of the order (how much the customer actually paid) */\n\tTotalPrice: number;\n\t/** Total discount for the entire order (excluding discounts for individual products in the order) */\n\tDiscount: number;\n\t/** Rounded cash amount the customer pays for an order (if paid in cash). Used only in countries with special rules for rounding cash */\n\tRoundedCashAmount?: number;\n}\n\nexport interface Product {\n\t/** Internal product identifier */\n\tId: string;\n\t/** The product's name */\n\tName: string;\n\t/** The quantity of this product in the order */\n\tQuantity: number;\n\tPricePerProduct: ProductPrice;\n\t/** List of ingredients removed from the product */\n\tRemovedIngredients: string[];\n\t/** Additional ingredients added to the product */\n\tAddedIngredients: AddedIngredient[];\n\n\t/** The marking data used in some countries to pass scanned barcode value to the cash register. */\n\tMarking?: MarkingCodes;\n\n\t/** The product excise information */\n\tExcise?: {\n\t\tisExcise: boolean;\n\t};\n\n\t/** Additional data that can be defined for specific country */\n\tCountrySpecific?: {\n\t\tUzbekistan?: UzbekistanProductData;\n\t\tKazakhstan?: KazakhstanProductData;\n\t};\n}\n\nexport interface ProductPrice {\n\t/** Price for 1 product excluding discount but with added ingredients */\n\tPrice: number;\n\t/** Discount for 1 product (excluding the discount for the entire order) */\n\tDiscount: number;\n\tTaxes: Tax[];\n}\n\nexport interface Tax {\n\t/** Type of tax: value added or sales */\n\tType: 'VAT' | 'Sales' | 'Unknown';\n\t/** Rate in percents */\n\tRate: number;\n\t// TODO add later: Value: number\n}\n\nexport interface AddedIngredient {\n\t/** Ingredient name */\n\tName: string;\n\t/** The amount of ingredients added in portions */\n\tQuantity: number;\n\t/** Ingredient price added to the product */\n\tPrice: number;\n}\n\nexport interface Customer {\n\t/** The name of the customer that he gave to the cashier */\n\tName: string;\n\t/** Customer's mailing address, which he set in his personal account */\n\tEmail: string | null;\n\t/** Any additional identifiers, e.g. customer's Tax Identification Number */\n\tIdentifiers: { [index: string]: string };\n}\n\nexport interface CashRegister {\n\t/** Internal cash register identifier */\n\tUUId: string;\n\t/**  */\n\tNumber: string;\n\t/** To calculate or not to calculate VAT */\n\tShouldCalculateTax: boolean;\n}\n\nexport interface PreviousReceipt {\n\t/** ID of the receipt returned by the POS printer. `null` if a print error has occurred. It is temporary field. Then it will be removed. Use `Identifier` instead of `Id` */\n\tId: number | null;\n\t/** Printed receipt type: sales receipt or refund receipt */\n\tType: 'Sell' | 'Refund';\n\t/** Date in format ISO 8601 (e.g. 2021-04-30T10:50:00.0000000+04:00) */\n\tPrintDateTime: string;\n\t/** ID of the receipt returned by the POS printer */\n\tIdentifier: string | null;\n\n\tCashboxId: string;\n\n\t/** Data returned by cash register after printing receipt */\n\tCashRegisterOutput?: string;\n\t/** Previous receipt payment type */\n\tPaymentType: PaymentType;\n}\n\nexport interface Organization {\n\t/** Full name of the organization */\n\tName: string;\n\t/** Legal address */\n\tAddress: string;\n\t/** Organization payment details */\n\tRequisites: { [index: string]: string };\n}\n\nexport interface Store {\n\t/** Actual address */\n\tAddress: string;\n}\n\ntype RussiaMarkingCode = {\n\t/** Russian country iso code */\n\tcountry: 643;\n\t/** In Russia it's the string of digits, letters, special symbols and group separator. */\n\tmarkingCode: string;\n};\n\ntype BelarusMarkingCodes = {\n\t/** Belarus country iso code */\n\tcountry: 112;\n\t/** Маркировка унифицированными контрольными знаками (УКЗ) */\n\tukzCode?: string;\n\t/** Маркировка средствами идентификации (СИ) */\n\tsiCode?: string;\n\t/** Маркировка с использованием штрихкода GTIN */\n\tgtinCode?: string;\n};\n\ntype ArmeniaMarkingCode = {\n\t/** Armenia country iso code */\n\tcountry: 51;\n\t/** In Armenia it's the string of digits letters, special symbols and group separator. */\n\tmarkingCode: string;\n};\n\ntype UzbekistanMarkingCode = {\n\t/** Uzbekistan country iso code */\n\tcountry: 860;\n\t/** In Uzbekistan it's the string of digits letters, special symbols and group separator. */\n\tmarkingCode: string;\n};\n\nexport type MarkingCodes =\n\t| RussiaMarkingCode\n\t| BelarusMarkingCodes\n\t| ArmeniaMarkingCode\n\t| UzbekistanMarkingCode\n\t| undefined;\n"],"mappings":";AAGO,IAAK,WAAL,kBAAKA,cAAL;AAINA,YAAA,WAAA,IAAY;AAIZA,YAAA,SAAA,IAAU;AAIVA,YAAA,SAAA,IAAU;AAZC,SAAAA;AAAA,GAAA,YAAA,CAAA,CAAA;;;AEUL,IAAK,YAAL,kBAAKC,eAAL;AACN,EAAAA,sBAAA,YAAS,KAAT;AACA,EAAAA,sBAAA,mBAAgB,KAAhB;AACA,EAAAA,sBAAA,aAAU,KAAV;AAHW,SAAAA;AAAA,GAAA;;;ACNL,IAAK,uCAAL,kBAAKC,0CAAL;AAEN,EAAAA,sCAAA,kBAAe;AAEf,EAAAA,sCAAA,UAAO;AAEP,EAAAA,sCAAA,WAAQ;AAER,EAAAA,sCAAA,cAAW;AARA,SAAAA;AAAA,GAAA;;;ACqEL,IAAK,YAAL,kBAAKC,eAAL;AACN,EAAAA,sBAAA,cAAW,KAAX;AACA,EAAAA,sBAAA,YAAS,KAAT;AACA,EAAAA,sBAAA,gBAAa,KAAb;AACA,EAAAA,sBAAA,kBAAe,KAAf;AACA,EAAAA,sBAAA,sBAAmB,KAAnB;AALW,SAAAA;AAAA,GAAA;AASL,IAAK,cAAL,kBAAKC,iBAAL;AACN,EAAAA,0BAAA,eAAY,KAAZ;AACA,EAAAA,0BAAA,UAAO,KAAP;AACA,EAAAA,0BAAA,gBAAa,KAAb;AACA,EAAAA,0BAAA,iBAAc,KAAd;AACA,EAAAA,0BAAA,YAAS,KAAT;AAEA,EAAAA,0BAAA,cAAW,KAAX;AACA,EAAAA,0BAAA,gBAAa,KAAb;AACA,EAAAA,0BAAA,WAAQ,KAAR;AATW,SAAAA;AAAA,GAAA;AAaL,IAAK,cAAL,kBAAKC,iBAAL;AACN,EAAAA,0BAAA,UAAO,KAAP;AACA,EAAAA,0BAAA,cAAW,KAAX;AACA,EAAAA,0BAAA,uBAAoB,KAApB;AACA,EAAAA,0BAAA,gBAAa,KAAb;AAJW,SAAAA;AAAA,GAAA;","names":["Business","OwnerType","DigitalReceiptNotificationPreference","OrderType","OrderSource","PaymentType"]}

package/examples/example-1.json

@@ -0,0 +1,93 @@
+{
+	"CashFromCustomer": 503,
+	"CashRegister": {
+		"Number": "31",
+		"ShouldCalculateTax": true,
+		"UUId": "0022487FBA1EBC6511EBA824DC4AE652"
+	},
+	"Customer": {
+		"Email": null,
+		"Identifiers": {
+			"NIP": "1231216692"
+		},
+		"Name": "Tom Riddle"
+	},
+	"Taxpayer": {
+		"IdentificationNumber": null
+	},
+	"Order": {
+		"CreateDate": "2021-05-05T17:18:05.8686153+03:00",
+		"Id": "0022487FBA1EBC6911EBADAC8BDE481C",
+		"Number": "23",
+		"PaymentType": "Cash",
+		"PaymentTypeEnum": 0,
+		"OrderSource": 2,
+		"Price": {
+			"Discount": 0,
+			"TotalPrice": 503
+		},
+		"DeliveryDate": "2021-05-05T18:18:05.8686153+03:00",
+		"OrderType": 3,
+		"Products": [
+			{
+				"AddedIngredients": [],
+				"Id": "000D3A240C71BE9A11E719BE2AB2D427",
+				"Name": "Dodster 1 pcs.",
+				"PricePerProduct": {
+					"Discount": 0,
+					"Price": 159,
+					"Taxes": []
+				},
+				"Quantity": 1,
+				"RemovedIngredients": []
+			},
+			{
+				"AddedIngredients": [],
+				"Id": "000D3A240C71BE9A11E719BE2AD13D0D",
+				"Name": "Coca Cola Zero 500 ml",
+				"PricePerProduct": {
+					"Discount": 0,
+					"Price": 95,
+					"Taxes": [
+						{
+							"Rate": 20,
+							"Type": "VAT"
+						}
+					]
+				},
+				"Quantity": 1,
+				"RemovedIngredients": []
+			},
+			{
+				"AddedIngredients": [],
+				"Id": "11EA5A11B53111A0CB4BC59232AF6200",
+				"Name": "Fanta Orange 1.5 l",
+				"PricePerProduct": {
+					"Discount": 0,
+					"Price": 249,
+					"Taxes": [
+						{
+							"Rate": 14,
+							"Type": "VAT"
+						}
+					]
+				},
+				"Quantity": 1,
+				"RemovedIngredients": []
+			}
+		]
+	},
+	"Organization": {
+		"Address": "71-75 Shelton Street, London, WC2H 9JQ, United Kingdom",
+		"Name": "Yukon Ltd Limited",
+		"Requisites": {
+			"VAT": "123456",
+			"SOME-OTHER-REQ-1": "1166313070681",
+			"SOME-OTHER-REQ-2": ""
+		}
+	},
+	"Store": {
+		"Address": "Platform 8 7/4, Kings Cross Station, London, N1 9AP, United Kingdom"
+	},
+	"PreviousReceipts": []
+}