Interface ZohoCrmNodeParameters

Source

interface ZohoCrmNodeParameters {
    accountId?: string;
    accountName?: string;
    additionalFields?:
        | {
            Account_Number?: string;
            Account_Site?: string;
            Account_Type?: string;
            Annual_Revenue?: number;
            Billing_Address?: {
                address_fields: {
                    Billing_City?: string;
                    Billing_Code?: string;
                    Billing_Country?: string;
                    Billing_State?: string;
                    Billing_Street?: string;
                };
            };
            Contact_Details?: string;
            Currency?: | "ALL"
            | "ARS"
            | "AUD"
            | "BRL"
            | "CAD"
            | "CHF"
            | "CNY"
            | "CZK"
            | "DKK"
            | "EUR"
            | "GBP"
            | "HKD"
            | "HUF"
            | "INR"
            | "JPY"
            | "KRW"
            | "MXN"
            | "NOK"
            | "NZD"
            | "PLN"
            | "RUB"
            | "SEK"
            | "SGD"
            | "THB"
            | "TWD"
            | "USD"
            | "ZAR"
            | "AFN"
            | "DZD"
            | "AZN"
            | "BSD"
            | "BBD"
            | "BZD"
            | "BMD"
            | "BOB"
            | "BND"
            | "BGN"
            | "CLP"
            | "COP"
            | "NIO"
            | "CRC"
            | "DOP"
            | "VND"
            | "XCD"
            | "EGP"
            | "FJD"
            | "UAH"
            | "JMD"
            | "KES"
            | "PGK"
            | "HRK"
            | "MMK"
            | "LAK"
            | "LBP"
            | "HNL"
            | "LRD"
            | "MYR"
            | "MUR"
            | "MAD"
            | "NPR"
            | "ILS"
            | "MRO"
            | "TOP"
            | "PKR"
            | "MOP"
            | "PHP"
            | "BWP"
            | "QAR"
            | "GTQ"
            | "RON"
            | "MVR"
            | "IDR"
            | "SAR"
            | "SCR"
            | "PEN"
            | "SBD"
            | "LKR"
            | "SYP"
            | "BDT"
            | "WST"
            | "KZT"
            | "TTD"
            | "TRY"
            | "AED"
            | "VUV"
            | "XOF"
            | "YER";
            customFields?: {
                customFields: {
                    fieldId?: string;
                    value?: string;
                }[];
            };
            Description?: string;
            Employees?: number;
            Exchange_Rate?: number;
            Fax?: string;
            Industry?: string;
            Phone?: string;
            Shipping_Address?: {
                address_fields: {
                    Shipping_City?: string;
                    Shipping_Code?: string;
                    Shipping_Country?: string;
                    Shipping_State?: string;
                    Shipping_Street?: string;
                };
            };
            Ticker_Symbol?: string;
            Website?: string;
        }
        | {
            Assistant?: string;
            Asst_Phone?: string;
            customFields?: {
                customFields: {
                    fieldId?: string;
                    value?: string;
                }[];
            };
            Date_of_Birth?: string;
            Department?: string;
            Description?: string;
            Email?: string;
            Fax?: string;
            First_Name?: string;
            Full_Name?: string;
            Home_Phone?: string;
            Mailing_Address?: {
                address_fields: {
                    Mailing_City?: string;
                    Mailing_Country?: string;
                    Mailing_State?: string;
                    Mailing_Street?: string;
                    Mailing_Zip?: string;
                };
            };
            Mobile?: string;
            Other_Address?: {
                address_fields: {
                    Other_City?: string;
                    Other_State?: string;
                    Other_Street?: string;
                    Other_Zip?: string;
                };
            };
            Other_Phone?: string;
            Phone?: string;
            Salutation?: string;
            Secondary_Email?: string;
            Skype_ID?: string;
            Title?: string;
            Twitter?: string;
        }
        | {
            Amount?: number;
            Closing_Date?: string;
            Currency?: | "ALL"
            | "ARS"
            | "AUD"
            | "BRL"
            | "CAD"
            | "CHF"
            | "CNY"
            | "CZK"
            | "DKK"
            | "EUR"
            | "GBP"
            | "HKD"
            | "HUF"
            | "INR"
            | "JPY"
            | "KRW"
            | "MXN"
            | "NOK"
            | "NZD"
            | "PLN"
            | "RUB"
            | "SEK"
            | "SGD"
            | "THB"
            | "TWD"
            | "USD"
            | "ZAR"
            | "AFN"
            | "DZD"
            | "AZN"
            | "BSD"
            | "BBD"
            | "BZD"
            | "BMD"
            | "BOB"
            | "BND"
            | "BGN"
            | "CLP"
            | "COP"
            | "NIO"
            | "CRC"
            | "DOP"
            | "VND"
            | "XCD"
            | "EGP"
            | "FJD"
            | "UAH"
            | "JMD"
            | "KES"
            | "PGK"
            | "HRK"
            | "MMK"
            | "LAK"
            | "LBP"
            | "HNL"
            | "LRD"
            | "MYR"
            | "MUR"
            | "MAD"
            | "NPR"
            | "ILS"
            | "MRO"
            | "TOP"
            | "PKR"
            | "MOP"
            | "PHP"
            | "BWP"
            | "QAR"
            | "GTQ"
            | "RON"
            | "MVR"
            | "IDR"
            | "SAR"
            | "SCR"
            | "PEN"
            | "SBD"
            | "LKR"
            | "SYP"
            | "BDT"
            | "WST"
            | "KZT"
            | "TTD"
            | "TRY"
            | "AED"
            | "VUV"
            | "XOF"
            | "YER";
            customFields?: {
                customFields: {
                    fieldId?: string;
                    value?: string;
                }[];
            };
            Description?: string;
            Lead_Conversion_Time?: number;
            Next_Step?: string;
            Overall_Sales_Duration?: number;
            Probability?: number;
            Sales_Cycle_Duration?: number;
        }
        | {
            accountId?: string;
            Adjustment?: number;
            Billing_Address?: {
                address_fields: {
                    Billing_City?: string;
                    Billing_Code?: string;
                    Billing_Country?: string;
                    Billing_State?: string;
                    Billing_Street?: string;
                };
            };
            Currency?: | "ALL"
            | "ARS"
            | "AUD"
            | "BRL"
            | "CAD"
            | "CHF"
            | "CNY"
            | "CZK"
            | "DKK"
            | "EUR"
            | "GBP"
            | "HKD"
            | "HUF"
            | "INR"
            | "JPY"
            | "KRW"
            | "MXN"
            | "NOK"
            | "NZD"
            | "PLN"
            | "RUB"
            | "SEK"
            | "SGD"
            | "THB"
            | "TWD"
            | "USD"
            | "ZAR"
            | "AFN"
            | "DZD"
            | "AZN"
            | "BSD"
            | "BBD"
            | "BZD"
            | "BMD"
            | "BOB"
            | "BND"
            | "BGN"
            | "CLP"
            | "COP"
            | "NIO"
            | "CRC"
            | "DOP"
            | "VND"
            | "XCD"
            | "EGP"
            | "FJD"
            | "UAH"
            | "JMD"
            | "KES"
            | "PGK"
            | "HRK"
            | "MMK"
            | "LAK"
            | "LBP"
            | "HNL"
            | "LRD"
            | "MYR"
            | "MUR"
            | "MAD"
            | "NPR"
            | "ILS"
            | "MRO"
            | "TOP"
            | "PKR"
            | "MOP"
            | "PHP"
            | "BWP"
            | "QAR"
            | "GTQ"
            | "RON"
            | "MVR"
            | "IDR"
            | "SAR"
            | "SCR"
            | "PEN"
            | "SBD"
            | "LKR"
            | "SYP"
            | "BDT"
            | "WST"
            | "KZT"
            | "TTD"
            | "TRY"
            | "AED"
            | "VUV"
            | "XOF"
            | "YER";
            customFields?: {
                customFields: {
                    fieldId?: string;
                    value?: string;
                }[];
            };
            Description?: string;
            Due_Date?: string;
            Exchange_Rate?: number;
            Grand_Total?: number;
            Invoice_Date?: string;
            Invoice_Number?: string;
            Sales_Commission?: number;
            Shipping_Address?: {
                address_fields: {
                    Shipping_City?: string;
                    Shipping_Code?: string;
                    Shipping_Country?: string;
                    Shipping_State?: string;
                    Shipping_Street?: string;
                };
            };
            Status?: string;
            Sub_Total?: number;
            Tax?: number;
            Terms_and_Conditions?: string;
        }
        | {
            Address?: {
                address_fields: {
                    City?: string;
                    Country?: string;
                    State?: string;
                    Street?: string;
                    Zip_Code?: string;
                };
            };
            Annual_Revenue?: number;
            Currency?: | "ALL"
            | "ARS"
            | "AUD"
            | "BRL"
            | "CAD"
            | "CHF"
            | "CNY"
            | "CZK"
            | "DKK"
            | "EUR"
            | "GBP"
            | "HKD"
            | "HUF"
            | "INR"
            | "JPY"
            | "KRW"
            | "MXN"
            | "NOK"
            | "NZD"
            | "PLN"
            | "RUB"
            | "SEK"
            | "SGD"
            | "THB"
            | "TWD"
            | "USD"
            | "ZAR"
            | "AFN"
            | "DZD"
            | "AZN"
            | "BSD"
            | "BBD"
            | "BZD"
            | "BMD"
            | "BOB"
            | "BND"
            | "BGN"
            | "CLP"
            | "COP"
            | "NIO"
            | "CRC"
            | "DOP"
            | "VND"
            | "XCD"
            | "EGP"
            | "FJD"
            | "UAH"
            | "JMD"
            | "KES"
            | "PGK"
            | "HRK"
            | "MMK"
            | "LAK"
            | "LBP"
            | "HNL"
            | "LRD"
            | "MYR"
            | "MUR"
            | "MAD"
            | "NPR"
            | "ILS"
            | "MRO"
            | "TOP"
            | "PKR"
            | "MOP"
            | "PHP"
            | "BWP"
            | "QAR"
            | "GTQ"
            | "RON"
            | "MVR"
            | "IDR"
            | "SAR"
            | "SCR"
            | "PEN"
            | "SBD"
            | "LKR"
            | "SYP"
            | "BDT"
            | "WST"
            | "KZT"
            | "TTD"
            | "TRY"
            | "AED"
            | "VUV"
            | "XOF"
            | "YER";
            customFields?: {
                customFields: {
                    fieldId?: string;
                    value?: string;
                }[];
            };
            Description?: string;
            Designation?: string;
            Email?: string;
            Email_Opt_Out?: boolean;
            Fax?: string;
            First_Name?: string;
            Full_Name?: string;
            Industry?: string;
            Industry_Type?: string;
            Lead_Source?: string;
            Lead_Status?: string;
            Mobile?: string;
            No_of_Employees?: number;
            Phone?: string;
            Salutation?: string;
            Secondary_Email?: string;
            Skype_ID?: string;
            Twitter?: string;
            Website?: string;
        }
        | {
            Commission_Rate?: number;
            customFields?: {
                customFields: {
                    fieldId?: string;
                    value?: string;
                }[];
            };
            Description?: string;
            Manufacturer?: string;
            Product_Active?: boolean;
            Product_Category?: string;
            Qty_in_Demand?: number;
            Qty_in_Stock?: number;
            Taxable?: boolean;
            Unit_Price?: number;
        }
        | {
            Adjustment?: number;
            Billing_Address?: {
                billing_address_fields: {
                    Billing_City?: string;
                    Billing_Code?: string;
                    Billing_Country?: string;
                    Billing_State?: string;
                    Billing_Street?: string;
                };
            };
            Carrier?: string;
            Currency?: | "ALL"
            | "ARS"
            | "AUD"
            | "BRL"
            | "CAD"
            | "CHF"
            | "CNY"
            | "CZK"
            | "DKK"
            | "EUR"
            | "GBP"
            | "HKD"
            | "HUF"
            | "INR"
            | "JPY"
            | "KRW"
            | "MXN"
            | "NOK"
            | "NZD"
            | "PLN"
            | "RUB"
            | "SEK"
            | "SGD"
            | "THB"
            | "TWD"
            | "USD"
            | "ZAR"
            | "AFN"
            | "DZD"
            | "AZN"
            | "BSD"
            | "BBD"
            | "BZD"
            | "BMD"
            | "BOB"
            | "BND"
            | "BGN"
            | "CLP"
            | "COP"
            | "NIO"
            | "CRC"
            | "DOP"
            | "VND"
            | "XCD"
            | "EGP"
            | "FJD"
            | "UAH"
            | "JMD"
            | "KES"
            | "PGK"
            | "HRK"
            | "MMK"
            | "LAK"
            | "LBP"
            | "HNL"
            | "LRD"
            | "MYR"
            | "MUR"
            | "MAD"
            | "NPR"
            | "ILS"
            | "MRO"
            | "TOP"
            | "PKR"
            | "MOP"
            | "PHP"
            | "BWP"
            | "QAR"
            | "GTQ"
            | "RON"
            | "MVR"
            | "IDR"
            | "SAR"
            | "SCR"
            | "PEN"
            | "SBD"
            | "LKR"
            | "SYP"
            | "BDT"
            | "WST"
            | "KZT"
            | "TTD"
            | "TRY"
            | "AED"
            | "VUV"
            | "XOF"
            | "YER";
            customFields?: {
                customFields: {
                    fieldId?: string;
                    value?: string;
                }[];
            };
            Description?: string;
            Discount?: number;
            Due_Date?: string;
            Exchange_Rate?: number;
            Grand_Total?: number;
            PO_Date?: string;
            PO_Number?: string;
            Sales_Commission?: number;
            Shipping_Address?: {
                address_fields: {
                    Shipping_City?: string;
                    Shipping_Code?: string;
                    Shipping_Country?: string;
                    Shipping_State?: string;
                    Shipping_Street?: string;
                };
            };
            Status?: string;
            Sub_Total?: number;
            Tax?: number;
            Terms_and_Conditions?: string;
            Tracking_Number?: string;
        }
        | {
            Adjustment?: number;
            Billing_Address?: {
                address_fields: {
                    Billing_City?: string;
                    Billing_Code?: string;
                    Billing_Country?: string;
                    Billing_State?: string;
                    Billing_Street?: string;
                };
            };
            Carrier?: string;
            Currency?: | "ALL"
            | "ARS"
            | "AUD"
            | "BRL"
            | "CAD"
            | "CHF"
            | "CNY"
            | "CZK"
            | "DKK"
            | "EUR"
            | "GBP"
            | "HKD"
            | "HUF"
            | "INR"
            | "JPY"
            | "KRW"
            | "MXN"
            | "NOK"
            | "NZD"
            | "PLN"
            | "RUB"
            | "SEK"
            | "SGD"
            | "THB"
            | "TWD"
            | "USD"
            | "ZAR"
            | "AFN"
            | "DZD"
            | "AZN"
            | "BSD"
            | "BBD"
            | "BZD"
            | "BMD"
            | "BOB"
            | "BND"
            | "BGN"
            | "CLP"
            | "COP"
            | "NIO"
            | "CRC"
            | "DOP"
            | "VND"
            | "XCD"
            | "EGP"
            | "FJD"
            | "UAH"
            | "JMD"
            | "KES"
            | "PGK"
            | "HRK"
            | "MMK"
            | "LAK"
            | "LBP"
            | "HNL"
            | "LRD"
            | "MYR"
            | "MUR"
            | "MAD"
            | "NPR"
            | "ILS"
            | "MRO"
            | "TOP"
            | "PKR"
            | "MOP"
            | "PHP"
            | "BWP"
            | "QAR"
            | "GTQ"
            | "RON"
            | "MVR"
            | "IDR"
            | "SAR"
            | "SCR"
            | "PEN"
            | "SBD"
            | "LKR"
            | "SYP"
            | "BDT"
            | "WST"
            | "KZT"
            | "TTD"
            | "TRY"
            | "AED"
            | "VUV"
            | "XOF"
            | "YER";
            customFields?: {
                customFields: {
                    fieldId?: string;
                    value?: string;
                }[];
            };
            Description?: string;
            Exchange_Rate?: number;
            Grand_Total?: number;
            Quote_Stage?: string;
            Shipping_Address?: {
                address_fields: {
                    Shipping_City?: string;
                    Shipping_Code?: string;
                    Shipping_Country?: string;
                    Shipping_State?: string;
                    Shipping_Street?: string;
                };
            };
            Sub_Total?: number;
            Tax?: number;
            Team?: string;
            Terms_and_Conditions?: string;
            Valid_Till?: string;
        }
        | {
            Adjustment?: number;
            Billing_Address?: {
                address_fields: {
                    Billing_City?: string;
                    Billing_Code?: string;
                    Billing_Country?: string;
                    Billing_State?: string;
                    Billing_Street?: string;
                };
            };
            Carrier?: string;
            contactId?: string;
            Currency?: | "ALL"
            | "ARS"
            | "AUD"
            | "BRL"
            | "CAD"
            | "CHF"
            | "CNY"
            | "CZK"
            | "DKK"
            | "EUR"
            | "GBP"
            | "HKD"
            | "HUF"
            | "INR"
            | "JPY"
            | "KRW"
            | "MXN"
            | "NOK"
            | "NZD"
            | "PLN"
            | "RUB"
            | "SEK"
            | "SGD"
            | "THB"
            | "TWD"
            | "USD"
            | "ZAR"
            | "AFN"
            | "DZD"
            | "AZN"
            | "BSD"
            | "BBD"
            | "BZD"
            | "BMD"
            | "BOB"
            | "BND"
            | "BGN"
            | "CLP"
            | "COP"
            | "NIO"
            | "CRC"
            | "DOP"
            | "VND"
            | "XCD"
            | "EGP"
            | "FJD"
            | "UAH"
            | "JMD"
            | "KES"
            | "PGK"
            | "HRK"
            | "MMK"
            | "LAK"
            | "LBP"
            | "HNL"
            | "LRD"
            | "MYR"
            | "MUR"
            | "MAD"
            | "NPR"
            | "ILS"
            | "MRO"
            | "TOP"
            | "PKR"
            | "MOP"
            | "PHP"
            | "BWP"
            | "QAR"
            | "GTQ"
            | "RON"
            | "MVR"
            | "IDR"
            | "SAR"
            | "SCR"
            | "PEN"
            | "SBD"
            | "LKR"
            | "SYP"
            | "BDT"
            | "WST"
            | "KZT"
            | "TTD"
            | "TRY"
            | "AED"
            | "VUV"
            | "XOF"
            | "YER";
            customFields?: {
                customFields: {
                    fieldId?: string;
                    value?: string;
                }[];
            };
            dealId?: string;
            Description?: string;
            Discount?: number;
            Due_Date?: string;
            Exchange_Rate?: number;
            Grand_Total?: number;
            Sales_Commission?: number;
            Shipping_Address?: {
                address_fields: {
                    Shipping_City?: string;
                    Shipping_Code?: string;
                    Shipping_Country?: string;
                    Shipping_State?: string;
                    Shipping_Street?: string;
                };
            };
            SO_Number?: string;
            Status?: string;
            Sub_Total?: number;
            Tax?: number;
            Terms_and_Conditions?: string;
        }
        | {
            Address?: {
                address_fields: {
                    City?: string;
                    Country?: string;
                    State?: string;
                    Street?: string;
                    Zip_Code?: string;
                };
            };
            Category?: string;
            Currency?: | "ALL"
            | "ARS"
            | "AUD"
            | "BRL"
            | "CAD"
            | "CHF"
            | "CNY"
            | "CZK"
            | "DKK"
            | "EUR"
            | "GBP"
            | "HKD"
            | "HUF"
            | "INR"
            | "JPY"
            | "KRW"
            | "MXN"
            | "NOK"
            | "NZD"
            | "PLN"
            | "RUB"
            | "SEK"
            | "SGD"
            | "THB"
            | "TWD"
            | "USD"
            | "ZAR"
            | "AFN"
            | "DZD"
            | "AZN"
            | "BSD"
            | "BBD"
            | "BZD"
            | "BMD"
            | "BOB"
            | "BND"
            | "BGN"
            | "CLP"
            | "COP"
            | "NIO"
            | "CRC"
            | "DOP"
            | "VND"
            | "XCD"
            | "EGP"
            | "FJD"
            | "UAH"
            | "JMD"
            | "KES"
            | "PGK"
            | "HRK"
            | "MMK"
            | "LAK"
            | "LBP"
            | "HNL"
            | "LRD"
            | "MYR"
            | "MUR"
            | "MAD"
            | "NPR"
            | "ILS"
            | "MRO"
            | "TOP"
            | "PKR"
            | "MOP"
            | "PHP"
            | "BWP"
            | "QAR"
            | "GTQ"
            | "RON"
            | "MVR"
            | "IDR"
            | "SAR"
            | "SCR"
            | "PEN"
            | "SBD"
            | "LKR"
            | "SYP"
            | "BDT"
            | "WST"
            | "KZT"
            | "TTD"
            | "TRY"
            | "AED"
            | "VUV"
            | "XOF"
            | "YER";
            customFields?: {
                customFields: {
                    fieldId?: string;
                    value?: string;
                }[];
            };
            Description?: string;
            Email?: string;
            Phone?: string;
            Website?: string;
        };
    Company?: string;
    contactId?: string;
    dealId?: string;
    dealName?: string;
    invoiceId?: string;
    lastName?: string;
    leadId?: string;
    limit?: number;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "upsert"
    | "getFields";
    options?: {
        approved?: boolean;
        converted?: boolean;
        fields?: unknown[];
        include_child?: boolean;
        sort_by?: string;
        sort_order?: "asc"
        | "desc";
        territory_id?: string;
    };
    Product_Details?: {
        id?: string;
        list_price?: number;
        net_total?: number;
        product_description?: string;
        quantity?: number;
        quantity_in_stock?: number;
        Tax?: number;
        total?: number;
        total_after_discount?: number;
        unit_price?: number;
    };
    productId?: string;
    productName?: string;
    purchaseOrderId?: string;
    quoteId?: string;
    resource?: | "account"
    | "contact"
    | "deal"
    | "invoice"
    | "lead"
    | "product"
    | "quote"
    | "vendor"
    | "salesOrder"
    | "purchaseOrder";
    returnAll?: boolean;
    salesOrderId?: string;
    stage?: string;
    subject?: string;
    updateFields?: | {
        Account_Name?: string;
        Account_Number?: string;
        Account_Site?: string;
        Account_Type?: string;
        Annual_Revenue?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Contact_Details?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Employees?: number;
        Exchange_Rate?: number;
        Fax?: string;
        Industry?: string;
        Phone?: string;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        Ticker_Symbol?: string;
        Website?: string;
    }
    | {
        Assistant?: string;
        Asst_Phone?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Date_of_Birth?: string;
        Department?: string;
        Description?: string;
        Email?: string;
        Fax?: string;
        First_Name?: string;
        Full_Name?: string;
        Home_Phone?: string;
        Last_Name?: string;
        Mailing_Address?: {
            address_fields: {
                Mailing_City?: string;
                Mailing_Country?: string;
                Mailing_State?: string;
                Mailing_Street?: string;
                Mailing_Zip?: string;
            };
        };
        Mobile?: string;
        Other_Address?: {
            address_fields: {
                Other_City?: string;
                Other_State?: string;
                Other_Street?: string;
                Other_Zip?: string;
            };
        };
        Other_Phone?: string;
        Phone?: string;
        Salutation?: string;
        Secondary_Email?: string;
        Skype_ID?: string;
        Title?: string;
        Twitter?: string;
    }
    | {
        Amount?: number;
        Closing_Date?: string;
        Currency?: string;
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Deal_Name?: string;
        Description?: string;
        Lead_Conversion_Time?: number;
        Next_Step?: string;
        Overall_Sales_Duration?: number;
        Probability?: number;
        Sales_Cycle_Duration?: number;
        Stage?: string;
    }
    | {
        accountId?: string;
        Adjustment?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Due_Date?: string;
        Exchange_Rate?: number;
        Grand_Total?: number;
        Invoice_Date?: string;
        Invoice_Number?: string;
        Product_Details?: {
            id?: string;
            list_price?: number;
            net_total?: number;
            product_description?: string;
            quantity?: number;
            quantity_in_stock?: number;
            Tax?: number;
            total?: number;
            total_after_discount?: number;
            unit_price?: number;
        };
        Sales_Commission?: number;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        Status?: string;
        Sub_Total?: number;
        Subject?: string;
        Tax?: number;
        Terms_and_Conditions?: string;
    }
    | {
        Address?: {
            address_fields: {
                City?: string;
                Country?: string;
                State?: string;
                Street?: string;
                Zip_Code?: string;
            };
        };
        Annual_Revenue?: number;
        Company?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Designation?: string;
        Email?: string;
        Email_Opt_Out?: boolean;
        Fax?: string;
        First_Name?: string;
        Full_Name?: string;
        Industry?: string;
        Industry_Type?: string;
        Last_Name?: string;
        Lead_Source?: string;
        Lead_Status?: string;
        Mobile?: string;
        No_of_Employees?: number;
        Phone?: string;
        Salutation?: string;
        Secondary_Email?: string;
        Skype_ID?: string;
        Twitter?: string;
        Website?: string;
    }
    | {
        Commission_Rate?: number;
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Manufacturer?: string;
        Product_Active?: boolean;
        Product_Category?: string;
        Qty_in_Demand?: number;
        Qty_in_Stock?: number;
        Taxable?: boolean;
        Unit_Price?: number;
    }
    | {
        Adjustment?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Carrier?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Discount?: number;
        Due_Date?: string;
        Exchange_Rate?: number;
        Grand_Total?: number;
        PO_Date?: string;
        PO_Number?: string;
        Sales_Commission?: number;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        Status?: string;
        Sub_Total?: number;
        Subject?: string;
        Tax?: number;
        Terms_and_Conditions?: string;
        Tracking_Number?: string;
    }
    | {
        Adjustment?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Carrier?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Exchange_Rate?: number;
        Grand_Total?: number;
        Quote_Stage?: string;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        Sub_Total?: number;
        Subject?: string;
        Tax?: number;
        Team?: string;
        Terms_and_Conditions?: string;
        Valid_Till?: string;
    }
    | {
        accountId?: string;
        Adjustment?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Carrier?: string;
        contactId?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        dealId?: string;
        Description?: string;
        Discount?: number;
        Due_Date?: string;
        Exchange_Rate?: number;
        Grand_Total?: number;
        Sales_Commission?: number;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        SO_Number?: string;
        Status?: string;
        Sub_Total?: number;
        Subject?: string;
        Tax?: number;
        Terms_and_Conditions?: string;
    }
    | {
        Address?: {
            address_fields: {
                City?: string;
                Country?: string;
                State?: string;
                Street?: string;
                Zip_Code?: string;
            };
        };
        Category?: string;
        Currency?: string;
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Email?: string;
        Phone?: string;
        Vendor_Name?: string;
        Website?: string;
    };
    vendorId?: string;
    vendorName?: string;
}

Properties§

Source§

readonly accountId?: string

ID of the account to delete. Can be found at the end of the URL.

Source§

readonly accountName?: string

Source§

readonly additionalFields?:
    | {
        Account_Number?: string;
        Account_Site?: string;
        Account_Type?: string;
        Annual_Revenue?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Contact_Details?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Employees?: number;
        Exchange_Rate?: number;
        Fax?: string;
        Industry?: string;
        Phone?: string;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        Ticker_Symbol?: string;
        Website?: string;
    }
    | {
        Assistant?: string;
        Asst_Phone?: string;
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Date_of_Birth?: string;
        Department?: string;
        Description?: string;
        Email?: string;
        Fax?: string;
        First_Name?: string;
        Full_Name?: string;
        Home_Phone?: string;
        Mailing_Address?: {
            address_fields: {
                Mailing_City?: string;
                Mailing_Country?: string;
                Mailing_State?: string;
                Mailing_Street?: string;
                Mailing_Zip?: string;
            };
        };
        Mobile?: string;
        Other_Address?: {
            address_fields: {
                Other_City?: string;
                Other_State?: string;
                Other_Street?: string;
                Other_Zip?: string;
            };
        };
        Other_Phone?: string;
        Phone?: string;
        Salutation?: string;
        Secondary_Email?: string;
        Skype_ID?: string;
        Title?: string;
        Twitter?: string;
    }
    | {
        Amount?: number;
        Closing_Date?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Lead_Conversion_Time?: number;
        Next_Step?: string;
        Overall_Sales_Duration?: number;
        Probability?: number;
        Sales_Cycle_Duration?: number;
    }
    | {
        accountId?: string;
        Adjustment?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Due_Date?: string;
        Exchange_Rate?: number;
        Grand_Total?: number;
        Invoice_Date?: string;
        Invoice_Number?: string;
        Sales_Commission?: number;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        Status?: string;
        Sub_Total?: number;
        Tax?: number;
        Terms_and_Conditions?: string;
    }
    | {
        Address?: {
            address_fields: {
                City?: string;
                Country?: string;
                State?: string;
                Street?: string;
                Zip_Code?: string;
            };
        };
        Annual_Revenue?: number;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Designation?: string;
        Email?: string;
        Email_Opt_Out?: boolean;
        Fax?: string;
        First_Name?: string;
        Full_Name?: string;
        Industry?: string;
        Industry_Type?: string;
        Lead_Source?: string;
        Lead_Status?: string;
        Mobile?: string;
        No_of_Employees?: number;
        Phone?: string;
        Salutation?: string;
        Secondary_Email?: string;
        Skype_ID?: string;
        Twitter?: string;
        Website?: string;
    }
    | {
        Commission_Rate?: number;
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Manufacturer?: string;
        Product_Active?: boolean;
        Product_Category?: string;
        Qty_in_Demand?: number;
        Qty_in_Stock?: number;
        Taxable?: boolean;
        Unit_Price?: number;
    }
    | {
        Adjustment?: number;
        Billing_Address?: {
            billing_address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Carrier?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Discount?: number;
        Due_Date?: string;
        Exchange_Rate?: number;
        Grand_Total?: number;
        PO_Date?: string;
        PO_Number?: string;
        Sales_Commission?: number;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        Status?: string;
        Sub_Total?: number;
        Tax?: number;
        Terms_and_Conditions?: string;
        Tracking_Number?: string;
    }
    | {
        Adjustment?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Carrier?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Exchange_Rate?: number;
        Grand_Total?: number;
        Quote_Stage?: string;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        Sub_Total?: number;
        Tax?: number;
        Team?: string;
        Terms_and_Conditions?: string;
        Valid_Till?: string;
    }
    | {
        Adjustment?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Carrier?: string;
        contactId?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        dealId?: string;
        Description?: string;
        Discount?: number;
        Due_Date?: string;
        Exchange_Rate?: number;
        Grand_Total?: number;
        Sales_Commission?: number;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        SO_Number?: string;
        Status?: string;
        Sub_Total?: number;
        Tax?: number;
        Terms_and_Conditions?: string;
    }
    | {
        Address?: {
            address_fields: {
                City?: string;
                Country?: string;
                State?: string;
                Street?: string;
                Zip_Code?: string;
            };
        };
        Category?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Email?: string;
        Phone?: string;
        Website?: string;
    }

Default: {}

Source§

readonly Company?: string

Company at which the lead works

Source§

readonly contactId?: string

ID of the contact to delete

Source§

readonly dealId?: string

ID of the deal to delete

Source§

readonly dealName?: string

Source§

readonly invoiceId?: string

ID of the invoice to delete

Source§

readonly lastName?: string

Source§

readonly leadId?: string

ID of the lead to delete

Source§

readonly limit?: number

Max number of results to return Default: 5 Type options: {"minValue":1,"maxValue":1000}

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "upsert"
    | "getFields"

Default: "create"

Source§

readonly options?: {
    approved?: boolean;
    converted?: boolean;
    fields?: unknown[];
    include_child?: boolean;
    sort_by?: string;
    sort_order?: "asc" | "desc";
    territory_id?: string;
}

Default: {}

Source§

readonly Product_Details?: {
    id?: string;
    list_price?: number;
    net_total?: number;
    product_description?: string;
    quantity?: number;
    quantity_in_stock?: number;
    Tax?: number;
    total?: number;
    total_after_discount?: number;
    unit_price?: number;
}

Default: {} Type options: {"multipleValues":true,"multipleValueButtonText":"Add Product"}

Source§

readonly productId?: string

ID of the product to delete

Source§

readonly productName?: string

Source§

readonly purchaseOrderId?: string

ID of the purchase order to delete

Source§

readonly quoteId?: string

ID of the quote to delete

Source§

readonly resource?:
    | "account"
    | "contact"
    | "deal"
    | "invoice"
    | "lead"
    | "product"
    | "quote"
    | "vendor"
    | "salesOrder"
    | "purchaseOrder"

Default: "account"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly salesOrderId?: string

ID of the sales order to delete

Source§

readonly stage?: string

Choose from the list, or specify an ID using an expression Default: [] Type options: {"loadOptionsMethod":"getDealStage"}

Source§

readonly subject?: string

Subject or title of the invoice

Source§

readonly updateFields?:
    | {
        Account_Name?: string;
        Account_Number?: string;
        Account_Site?: string;
        Account_Type?: string;
        Annual_Revenue?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Contact_Details?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Employees?: number;
        Exchange_Rate?: number;
        Fax?: string;
        Industry?: string;
        Phone?: string;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        Ticker_Symbol?: string;
        Website?: string;
    }
    | {
        Assistant?: string;
        Asst_Phone?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Date_of_Birth?: string;
        Department?: string;
        Description?: string;
        Email?: string;
        Fax?: string;
        First_Name?: string;
        Full_Name?: string;
        Home_Phone?: string;
        Last_Name?: string;
        Mailing_Address?: {
            address_fields: {
                Mailing_City?: string;
                Mailing_Country?: string;
                Mailing_State?: string;
                Mailing_Street?: string;
                Mailing_Zip?: string;
            };
        };
        Mobile?: string;
        Other_Address?: {
            address_fields: {
                Other_City?: string;
                Other_State?: string;
                Other_Street?: string;
                Other_Zip?: string;
            };
        };
        Other_Phone?: string;
        Phone?: string;
        Salutation?: string;
        Secondary_Email?: string;
        Skype_ID?: string;
        Title?: string;
        Twitter?: string;
    }
    | {
        Amount?: number;
        Closing_Date?: string;
        Currency?: string;
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Deal_Name?: string;
        Description?: string;
        Lead_Conversion_Time?: number;
        Next_Step?: string;
        Overall_Sales_Duration?: number;
        Probability?: number;
        Sales_Cycle_Duration?: number;
        Stage?: string;
    }
    | {
        accountId?: string;
        Adjustment?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Due_Date?: string;
        Exchange_Rate?: number;
        Grand_Total?: number;
        Invoice_Date?: string;
        Invoice_Number?: string;
        Product_Details?: {
            id?: string;
            list_price?: number;
            net_total?: number;
            product_description?: string;
            quantity?: number;
            quantity_in_stock?: number;
            Tax?: number;
            total?: number;
            total_after_discount?: number;
            unit_price?: number;
        };
        Sales_Commission?: number;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        Status?: string;
        Sub_Total?: number;
        Subject?: string;
        Tax?: number;
        Terms_and_Conditions?: string;
    }
    | {
        Address?: {
            address_fields: {
                City?: string;
                Country?: string;
                State?: string;
                Street?: string;
                Zip_Code?: string;
            };
        };
        Annual_Revenue?: number;
        Company?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Designation?: string;
        Email?: string;
        Email_Opt_Out?: boolean;
        Fax?: string;
        First_Name?: string;
        Full_Name?: string;
        Industry?: string;
        Industry_Type?: string;
        Last_Name?: string;
        Lead_Source?: string;
        Lead_Status?: string;
        Mobile?: string;
        No_of_Employees?: number;
        Phone?: string;
        Salutation?: string;
        Secondary_Email?: string;
        Skype_ID?: string;
        Twitter?: string;
        Website?: string;
    }
    | {
        Commission_Rate?: number;
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Manufacturer?: string;
        Product_Active?: boolean;
        Product_Category?: string;
        Qty_in_Demand?: number;
        Qty_in_Stock?: number;
        Taxable?: boolean;
        Unit_Price?: number;
    }
    | {
        Adjustment?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Carrier?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Discount?: number;
        Due_Date?: string;
        Exchange_Rate?: number;
        Grand_Total?: number;
        PO_Date?: string;
        PO_Number?: string;
        Sales_Commission?: number;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        Status?: string;
        Sub_Total?: number;
        Subject?: string;
        Tax?: number;
        Terms_and_Conditions?: string;
        Tracking_Number?: string;
    }
    | {
        Adjustment?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Carrier?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Exchange_Rate?: number;
        Grand_Total?: number;
        Quote_Stage?: string;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        Sub_Total?: number;
        Subject?: string;
        Tax?: number;
        Team?: string;
        Terms_and_Conditions?: string;
        Valid_Till?: string;
    }
    | {
        accountId?: string;
        Adjustment?: number;
        Billing_Address?: {
            address_fields: {
                Billing_City?: string;
                Billing_Code?: string;
                Billing_Country?: string;
                Billing_State?: string;
                Billing_Street?: string;
            };
        };
        Carrier?: string;
        contactId?: string;
        Currency?: | "ALL"
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR"
        | "AFN"
        | "DZD"
        | "AZN"
        | "BSD"
        | "BBD"
        | "BZD"
        | "BMD"
        | "BOB"
        | "BND"
        | "BGN"
        | "CLP"
        | "COP"
        | "NIO"
        | "CRC"
        | "DOP"
        | "VND"
        | "XCD"
        | "EGP"
        | "FJD"
        | "UAH"
        | "JMD"
        | "KES"
        | "PGK"
        | "HRK"
        | "MMK"
        | "LAK"
        | "LBP"
        | "HNL"
        | "LRD"
        | "MYR"
        | "MUR"
        | "MAD"
        | "NPR"
        | "ILS"
        | "MRO"
        | "TOP"
        | "PKR"
        | "MOP"
        | "PHP"
        | "BWP"
        | "QAR"
        | "GTQ"
        | "RON"
        | "MVR"
        | "IDR"
        | "SAR"
        | "SCR"
        | "PEN"
        | "SBD"
        | "LKR"
        | "SYP"
        | "BDT"
        | "WST"
        | "KZT"
        | "TTD"
        | "TRY"
        | "AED"
        | "VUV"
        | "XOF"
        | "YER";
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        dealId?: string;
        Description?: string;
        Discount?: number;
        Due_Date?: string;
        Exchange_Rate?: number;
        Grand_Total?: number;
        Sales_Commission?: number;
        Shipping_Address?: {
            address_fields: {
                Shipping_City?: string;
                Shipping_Code?: string;
                Shipping_Country?: string;
                Shipping_State?: string;
                Shipping_Street?: string;
            };
        };
        SO_Number?: string;
        Status?: string;
        Sub_Total?: number;
        Subject?: string;
        Tax?: number;
        Terms_and_Conditions?: string;
    }
    | {
        Address?: {
            address_fields: {
                City?: string;
                Country?: string;
                State?: string;
                Street?: string;
                Zip_Code?: string;
            };
        };
        Category?: string;
        Currency?: string;
        customFields?: {
            customFields: { fieldId?: string; value?: string }[];
        };
        Description?: string;
        Email?: string;
        Phone?: string;
        Vendor_Name?: string;
        Website?: string;
    }

Default: {}

Source§

readonly vendorId?: string

ID of the vendor associated with the purchase order. Choose from the list, or specify an ID using an expression. Default: [] Type options: {"loadOptionsMethod":"getVendors"}

Source§

Interface ZohoCrmNodeParametersCopy item path

Properties§

readonly accountId?: string

readonly accountName?: string

readonly Company?: string

readonly contactId?: string

readonly dealId?: string

readonly dealName?: string

readonly invoiceId?: string

readonly lastName?: string

readonly leadId?: string

readonly limit?: number

readonly operation?: | "create" | "get" | "getAll" | "update" | "delete" | "upsert" | "getFields"

readonly options?: { approved?: boolean; converted?: boolean; fields?: unknown[]; include_child?: boolean; sort_by?: string; sort_order?: "asc" | "desc"; territory_id?: string;}

readonly Product_Details?: { id?: string; list_price?: number; net_total?: number; product_description?: string; quantity?: number; quantity_in_stock?: number; Tax?: number; total?: number; total_after_discount?: number; unit_price?: number;}

readonly productId?: string

readonly productName?: string

readonly purchaseOrderId?: string

readonly quoteId?: string

readonly resource?: | "account" | "contact" | "deal" | "invoice" | "lead" | "product" | "quote" | "vendor" | "salesOrder" | "purchaseOrder"

readonly returnAll?: boolean

readonly salesOrderId?: string

readonly stage?: string

readonly subject?: string

readonly vendorId?: string

readonly vendorName?: string

Interface ZohoCrmNodeParameters

readonly operation?:
| "create"
| "get"
| "getAll"
| "update"
| "delete"
| "upsert"
| "getFields"

readonly options?: {
approved?: boolean;
converted?: boolean;
fields?: unknown[];
include_child?: boolean;
sort_by?: string;
sort_order?: "asc" | "desc";
territory_id?: string;
}

readonly Product_Details?: {
id?: string;
list_price?: number;
net_total?: number;
product_description?: string;
quantity?: number;
quantity_in_stock?: number;
Tax?: number;
total?: number;
total_after_discount?: number;
unit_price?: number;
}

readonly resource?:
| "account"
| "contact"
| "deal"
| "invoice"
| "lead"
| "product"
| "quote"
| "vendor"
| "salesOrder"
| "purchaseOrder"