erpnext-queue-client 1.38.0 → 2.0.0-beta.0

package/dist/erpnext/model/SalesInvoice.js

@@ -0,0 +1,326 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SalesInvoiceDraft = exports.SalesInvoice = exports.SalesInvoicePayment = exports.SalesInvoiceAdvance = exports.SalesInvoiceItem = void 0;
+const zod_1 = require("zod");
+const Boolean_1 = require("./Boolean");
+const zodContextOptionals_1 = require("../../utils/zodContextOptionals");
+const SalesTaxesAndCharges_1 = require("./SalesTaxesAndCharges");
+const DocTypeHelpers_1 = require("./DocTypeHelpers");
+// Sales Invoice Item Schema
+exports.SalesInvoiceItem = zod_1.z
+    .object({
+    // Core Item Information
+    barcode: zod_1.z.string().optional(),
+    has_item_scanned: Boolean_1.ERPNextBoolean,
+    item_code: zod_1.z.string().min(1, "Item Code is required"),
+    customer_item_code: zod_1.z.string().optional(),
+    item_name: zod_1.z.string().min(1, "Item Name is required"),
+    description: zod_1.z.string().optional(),
+    image: zod_1.z.string().optional(),
+    item_group: zod_1.z.string().optional(),
+    brand: zod_1.z.string().optional(),
+    // Quantity and UOM
+    qty: zod_1.z.number().positive("Quantity must be positive"),
+    stock_uom: zod_1.z.string().optional(),
+    uom: zod_1.z.string().min(1, "UOM is required"),
+    conversion_factor: zod_1.z.number().optional(),
+    stock_qty: zod_1.z.number().optional(),
+    // Pricing
+    price_list_rate: zod_1.z.number().optional(),
+    base_price_list_rate: zod_1.z.number().optional(),
+    // Discount and Margin
+    margin_type: zod_1.z.enum(["", "Percentage", "Amount"]).optional(),
+    margin_rate_or_amount: zod_1.z.number().optional(),
+    rate_with_margin: zod_1.z.number().optional(),
+    discount_percentage: zod_1.z.number().optional(),
+    discount_amount: zod_1.z.number().optional(),
+    base_rate_with_margin: zod_1.z.number().optional(),
+    // Rate and Amount
+    rate: zod_1.z.number().min(1, "Rate is required"),
+    amount: zod_1.z.number().optional(),
+    base_rate: zod_1.z.number().optional(),
+    base_amount: zod_1.z.number().optional(),
+    item_tax_template: zod_1.z.string().optional(),
+    // Pricing Rules
+    pricing_rules: zod_1.z.string().optional(),
+    stock_uom_rate: zod_1.z.number().optional(),
+    is_free_item: Boolean_1.ERPNextBoolean,
+    grant_commission: Boolean_1.ERPNextBoolean,
+    // Net Amounts
+    net_rate: zod_1.z.number().optional(),
+    net_amount: zod_1.z.number().optional(),
+    base_net_rate: zod_1.z.number().optional(),
+    base_net_amount: zod_1.z.number().optional(),
+    // Drop Ship
+    delivered_by_supplier: Boolean_1.ERPNextBoolean,
+    // Weight
+    weight_per_unit: zod_1.z.number().optional(),
+    total_weight: zod_1.z.number().optional(),
+    weight_uom: zod_1.z.string().optional(),
+    // Warehouse and Stock
+    warehouse: zod_1.z.string().optional(),
+    target_warehouse: zod_1.z.string().optional(),
+    quality_inspection: zod_1.z.string().optional(),
+    serial_no: zod_1.z.string().optional(),
+    batch_no: zod_1.z.string().optional(),
+    allow_zero_valuation_rate: Boolean_1.ERPNextBoolean,
+    incoming_rate: zod_1.z.number().optional(),
+    item_tax_rate: zod_1.z.string().optional(),
+    actual_batch_qty: zod_1.z.number().optional(),
+    actual_qty: zod_1.z.number().optional(),
+    // References
+    sales_order: zod_1.z.string().optional(),
+    so_detail: zod_1.z.string().optional(),
+    delivery_note: zod_1.z.string().optional(),
+    dn_detail: zod_1.z.string().optional(),
+    delivered_qty: zod_1.z.number().optional(),
+    sales_invoice_item: zod_1.z.string().optional(),
+    // Accounting
+    income_account: zod_1.z.string().min(1, "Income Account is required"),
+    expense_account: zod_1.z.string().optional(),
+    cost_center: zod_1.z.string().optional(),
+    discount_account: zod_1.z.string().optional(),
+    // Deferred Revenue
+    enable_deferred_revenue: Boolean_1.ERPNextBoolean,
+    deferred_revenue_account: zod_1.z.string().optional(),
+    service_start_date: zod_1.z.string().optional(), // Date string
+    service_stop_date: zod_1.z.string().optional(), // Date string
+    service_end_date: zod_1.z.string().optional(), // Date string
+    // Fixed Assets
+    is_fixed_asset: Boolean_1.ERPNextBoolean,
+    asset: zod_1.z.string().optional(),
+    finance_book: zod_1.z.string().optional(),
+    // Additional
+    project: zod_1.z.string().optional(),
+    page_break: Boolean_1.ERPNextBoolean,
+    use_serial_batch_fields: Boolean_1.ERPNextBoolean,
+    serial_and_batch_bundle: zod_1.z.string().optional(),
+    // Internal Transfer
+    purchase_order: zod_1.z.string().optional(),
+    purchase_order_item: zod_1.z.string().optional(),
+})
+    .describe("Sales Invoice Item");
+// Sales Invoice Advance Schema
+exports.SalesInvoiceAdvance = zod_1.z.object({
+    doctype: zod_1.z.literal("Sales Invoice Advance"),
+    reference_type: zod_1.z.string(),
+    reference_name: zod_1.z.string(),
+    reference_row: zod_1.z.string().optional(),
+    advance_amount: zod_1.z.number(),
+    allocated_amount: zod_1.z.number().optional(),
+    remarks: zod_1.z.string().optional(),
+});
+// Sales Invoice Payment Schema
+exports.SalesInvoicePayment = zod_1.z.object({
+    mode_of_payment: zod_1.z.string(),
+    amount: zod_1.z.number(),
+    base_amount: zod_1.z.number().optional(),
+    account: zod_1.z.string().optional(),
+    reference_no: zod_1.z.string().optional(),
+    clearance_date: zod_1.z.string().optional(), // Date string
+});
+// Main Sales Invoice Schema
+exports.SalesInvoice = zod_1.z
+    .object({
+    // Document Info
+    custom_invoice_no: zod_1.z.string(),
+    naming_series: (0, zodContextOptionals_1.optionalForInput)(zod_1.z.enum(["INV-.#", "INV-.#-GS"]).default("INV-.#")),
+    title: zod_1.z.string().optional(),
+    amended_from: zod_1.z.string().optional(),
+    // Customer Information
+    customer: zod_1.z.string().min(1, "Customer is required"),
+    customer_name: zod_1.z.string().optional(),
+    tax_id: zod_1.z.string().optional(),
+    company_tax_id: zod_1.z.string().optional(),
+    // Dates
+    posting_date: zod_1.z.string().min(1, "Posting Date is required"), // Date string
+    posting_time: zod_1.z.string().optional(), // Time string
+    set_posting_time: Boolean_1.ERPNextBoolean,
+    due_date: zod_1.z.string().optional(), // Date string
+    // Company
+    company: zod_1.z.string().min(1, "Company is required"),
+    // POS
+    is_pos: Boolean_1.ERPNextBoolean,
+    pos_profile: zod_1.z.string().optional(),
+    // Return Information
+    is_return: Boolean_1.ERPNextBoolean,
+    return_against: zod_1.z.string().optional(),
+    is_debit_note: Boolean_1.ERPNextBoolean,
+    update_outstanding_for_self: Boolean_1.ERPNextBoolean,
+    update_billed_amount_in_sales_order: Boolean_1.ERPNextBoolean,
+    update_billed_amount_in_delivery_note: Boolean_1.ERPNextBoolean,
+    // Consolidated
+    is_consolidated: Boolean_1.ERPNextBoolean,
+    // Currency and Price List
+    currency: zod_1.z.string().min(1, "Currency is required"),
+    conversion_rate: (0, zodContextOptionals_1.optionalForInput)(zod_1.z.number().min(0).default(1)),
+    selling_price_list: zod_1.z.string().min(1, "Selling Price List is required"),
+    price_list_currency: zod_1.z.string().optional(),
+    plc_conversion_rate: (0, zodContextOptionals_1.optionalForInput)(zod_1.z.number().min(0).default(1)),
+    ignore_pricing_rule: Boolean_1.ERPNextBoolean,
+    // Stock Management
+    update_stock: Boolean_1.ERPNextBoolean,
+    scan_barcode: zod_1.z.string().optional(),
+    set_warehouse: zod_1.z.string().optional(),
+    set_target_warehouse: zod_1.z.string().optional(),
+    // Items
+    items: zod_1.z.array(exports.SalesInvoiceItem).min(1, "At least one item is required"),
+    // Totals
+    total_qty: zod_1.z.number().optional(),
+    total_net_weight: zod_1.z.number().optional(),
+    base_total: zod_1.z.number().optional(),
+    base_net_total: zod_1.z.number().optional(),
+    total: zod_1.z.number().optional(),
+    net_total: zod_1.z.number().optional(),
+    // Taxes
+    tax_category: zod_1.z.string().optional(),
+    taxes_and_charges: zod_1.z.string().optional(),
+    shipping_rule: zod_1.z.string().optional(),
+    incoterm: zod_1.z.string().optional(),
+    named_place: zod_1.z.string().optional(),
+    taxes: zod_1.z.array(SalesTaxesAndCharges_1.SalesTaxesAndCharges).optional(),
+    base_total_taxes_and_charges: zod_1.z.number().optional(),
+    total_taxes_and_charges: zod_1.z.number().optional(),
+    other_charges_calculation: zod_1.z.string().optional(),
+    // Grand Total
+    base_grand_total: zod_1.z.number().optional(),
+    base_rounding_adjustment: zod_1.z.number().optional(),
+    base_rounded_total: zod_1.z.number().optional(),
+    base_in_words: zod_1.z.string().optional(),
+    grand_total: zod_1.z.number().optional(),
+    rounding_adjustment: zod_1.z.number().optional(),
+    rounded_total: zod_1.z.number().optional(),
+    in_words: zod_1.z.string().optional(),
+    disable_rounded_total: Boolean_1.ERPNextBoolean,
+    use_company_roundoff_cost_center: Boolean_1.ERPNextBoolean,
+    // Additional Discount
+    apply_discount_on: (0, zodContextOptionals_1.optionalForInput)(zod_1.z.enum(["", "Grand Total", "Net Total"]).default("Grand Total")),
+    base_discount_amount: zod_1.z.number().optional(),
+    additional_discount_percentage: zod_1.z.number().optional(),
+    discount_amount: zod_1.z.number().optional(),
+    coupon_code: zod_1.z.string().optional(),
+    is_cash_or_non_trade_discount: Boolean_1.ERPNextBoolean,
+    additional_discount_account: zod_1.z.string().optional(),
+    // Pricing Rules
+    pricing_rules: zod_1.z.array(zod_1.z.any()).optional(),
+    // Packing
+    packed_items: zod_1.z.array(zod_1.z.any()).optional(),
+    // Time Sheets
+    timesheets: zod_1.z.array(zod_1.z.any()).optional(),
+    total_billing_hours: zod_1.z.number().optional(),
+    total_billing_amount: zod_1.z.number().optional(),
+    // Addresses
+    customer_address: zod_1.z.string().optional(),
+    address_display: zod_1.z.string().optional(),
+    contact_person: zod_1.z.string().optional(),
+    contact_display: zod_1.z.string().optional(),
+    contact_mobile: zod_1.z.string().optional(),
+    contact_email: zod_1.z.string().optional(),
+    territory: zod_1.z.string().optional(),
+    shipping_address_name: zod_1.z.string().optional(),
+    shipping_address: zod_1.z.string().optional(),
+    dispatch_address_name: zod_1.z.string().optional(),
+    dispatch_address: zod_1.z.string().optional(),
+    company_address: zod_1.z.string().optional(),
+    company_address_display: zod_1.z.string().optional(),
+    // Customer PO Details
+    po_no: zod_1.z.string().optional(),
+    po_date: zod_1.z.string().optional(), // Date string
+    // Payment Terms
+    ignore_default_payment_terms_template: Boolean_1.ERPNextBoolean,
+    payment_terms_template: zod_1.z.string().optional(),
+    payment_schedule: zod_1.z.array(zod_1.z.any()).optional(),
+    // Terms and Conditions
+    tc_name: zod_1.z.string().optional(),
+    terms: zod_1.z.string().optional(),
+    // Payments (POS)
+    cash_bank_account: zod_1.z.string().optional(),
+    payments: zod_1.z.array(exports.SalesInvoicePayment).optional(),
+    base_paid_amount: zod_1.z.number().optional(),
+    paid_amount: zod_1.z.number().optional(),
+    base_change_amount: zod_1.z.number().optional(),
+    change_amount: zod_1.z.number().optional(),
+    account_for_change_amount: zod_1.z.string().optional(),
+    // Advances
+    allocate_advances_automatically: Boolean_1.ERPNextBoolean,
+    only_include_allocated_payments: Boolean_1.ERPNextBoolean,
+    advances: zod_1.z.array(exports.SalesInvoiceAdvance).optional(),
+    // Write Off
+    write_off_amount: zod_1.z.number().optional(),
+    base_write_off_amount: zod_1.z.number().optional(),
+    write_off_outstanding_amount_automatically: Boolean_1.ERPNextBoolean,
+    write_off_account: zod_1.z.string().optional(),
+    write_off_cost_center: zod_1.z.string().optional(),
+    // Loyalty
+    redeem_loyalty_points: Boolean_1.ERPNextBoolean,
+    loyalty_points: zod_1.z.number().optional(),
+    loyalty_amount: zod_1.z.number().optional(),
+    loyalty_program: zod_1.z.string().optional(),
+    dont_create_loyalty_points: Boolean_1.ERPNextBoolean,
+    loyalty_redemption_account: zod_1.z.string().optional(),
+    loyalty_redemption_cost_center: zod_1.z.string().optional(),
+    // Outstanding
+    total_advance: zod_1.z.number().optional(),
+    outstanding_amount: zod_1.z.number().optional(),
+    // Accounting
+    cost_center: zod_1.z.string().optional(),
+    project: zod_1.z.string().optional(),
+    debit_to: zod_1.z.string().min(1, "Debit To Account is required"),
+    party_account_currency: zod_1.z.string().optional(),
+    is_opening: (0, zodContextOptionals_1.optionalForInput)(zod_1.z.enum(["No", "Yes"]).default("No")),
+    unrealized_profit_loss_account: zod_1.z.string().optional(),
+    against_income_account: zod_1.z.string().optional(),
+    // Internal Customer
+    is_internal_customer: Boolean_1.ERPNextBoolean,
+    represents_company: zod_1.z.string().optional(),
+    // Sales Commission
+    sales_partner: zod_1.z.string().optional(),
+    amount_eligible_for_commission: zod_1.z.number().optional(),
+    commission_rate: zod_1.z.number().optional(),
+    total_commission: zod_1.z.number().optional(),
+    sales_team: zod_1.z.array(zod_1.z.any()).optional(),
+    // Printing
+    letter_head: zod_1.z.string().optional(),
+    group_same_items: Boolean_1.ERPNextBoolean,
+    select_print_heading: zod_1.z.string().optional(),
+    language: zod_1.z.string().optional(),
+    // Subscription
+    subscription: zod_1.z.string().optional(),
+    from_date: zod_1.z.string().optional(), // Date string
+    to_date: zod_1.z.string().optional(), // Date string
+    auto_repeat: zod_1.z.string().optional(),
+    update_auto_repeat_reference: zod_1.z.string().optional(),
+    // Status
+    status: (0, zodContextOptionals_1.optionalForInput)(zod_1.z
+        .enum([
+        "Draft",
+        "Return",
+        "Credit Note Issued",
+        "Submitted",
+        "Paid",
+        "Partly Paid",
+        "Unpaid",
+        "Unpaid and Discounted",
+        "Partly Paid and Discounted",
+        "Overdue and Discounted",
+        "Overdue",
+        "Cancelled",
+        "Internal Transfer",
+    ])
+        .default("Draft")),
+    // Additional Info
+    source: zod_1.z.string().optional(),
+    customer_group: zod_1.z.string().optional(),
+    is_discounted: Boolean_1.ERPNextBoolean,
+    remarks: zod_1.z.string().optional(),
+    campaign: zod_1.z.string().optional(),
+    inter_company_invoice_reference: zod_1.z.string().optional(),
+    // Other
+    repost_required: Boolean_1.ERPNextBoolean,
+})
+    .describe("Sales Invoice");
+exports.SalesInvoiceDraft = (0, DocTypeHelpers_1.DocModel)(exports.SalesInvoice)
+    .omit({
+    name: true,
+})
+    .describe("Sales Invoice Draft");