Copying line items in custom code

n this comprehensive guide, we delve into the intricacies of implementing a custom-coded action within a HubSpot workflow, specifically tailored for the purpose of cloning line items from one deal to another. This functionality proves invaluable in scenarios such as deal renewals, where duplicating line items from the original deal to the renewal deal is required. By automating this process, we significantly streamline operations, enhancing efficiency and accuracy.

// Exclude once-off payments ("recurringbillingfrequency": null):
const OnceOffPayments_included = false;

// Import required libraries
const hubspot = require('@hubspot/api-client');

exports.main = async (event, callback) => {
    // Create a new HubSpot API Client
    const hubspotClient = new hubspot.Client({
        accessToken: process.env.PrivateAppDealActions
    });

  //Retrieving the included properties
  const hs_object_id = event.inputFields['hs_object_id'];  
  const parent_id = event.inputFields['parent_id'];

    async function fetchAssociations(fromObjectType, fromObjectId, toObjectType) {
        try {
            const response = await hubspotClient.crm.associations.v4.basicApi.getPage(fromObjectType, fromObjectId, toObjectType, undefined, 100);
            return response.results.map(({ toObjectId }) => String(toObjectId));
        } catch (error) {
            console.error(`Failed to fetch ${toObjectType} associations for ${fromObjectType} ${fromObjectId}:`, error.message);
            return [];
        }
    }

    const associatedLineItemsParent = await fetchAssociations('deals', parent_id, 'line_items');

    const inputs = await Promise.all(associatedLineItemsParent.map(async (lineItemId) => {
        const lineItemResponse = await hubspotClient.crm.lineItems.basicApi.getById(lineItemId, [
            'name',
            'quantity',
            'price',
            // Add other necessary properties here
        ]);
        
        const properties = lineItemResponse.properties;
        ['createdate', 'hs_lastmodifieddate', 'hs_object_id'].forEach(prop => delete properties[prop]);

        const associations = OnceOffPayments_included || properties.recurringbillingfrequency !== null ? [{
            to: { id: hs_object_id },
            types: [
                {
                    associationCategory: "HUBSPOT_DEFINED",
                    associationTypeId: 20,
                },
            ],
        }] : [];

        return { 
            properties,
            associations
        };
    }));

    try {
        const apiResponse = await hubspotClient.crm.lineItems.batchApi.create({ inputs });
        console.log(JSON.stringify(apiResponse, null, 2));

        callback({
            outputFields: {
                // Output fields here if necessary
            }
        });
    } catch (e) {
        console.error('Error:', e.message || 'An error occurred');
        callback({ error: e.message });
    }
};

Conclusion

The script outlined above provides a streamlined and efficient solution for cloning line items from one deal to another within HubSpot. By leveraging JavaScript alongside HubSpot's API Client, we automate a previously manual and error-prone process, enhancing operational efficiency and data accuracy. This workflow is adaptable, catering to different business needs by allowing the inclusion or exclusion of once-off payments. Through automation, we free up valuable time and resources, enabling focus on strategic business activities that drive growth and success.

// Exclude once-off payments ("recurringbillingfrequency": null):
const OnceOffPayments_included = false;

// Import required libraries
const hubspot = require('@hubspot/api-client');

exports.main = async (event, callback) => {
    // Create a new HubSpot API Client
    const hubspotClient = new hubspot.Client({
        accessToken: process.env.PrivateAppDealActions
    });

    // Retrieving the included input fields
    const hs_object_id = event.inputFields['hs_object_id'];
    const parent_id = event.inputFields['parent_id'];

    // Helper function to fetch associations
    async function fetchAssociations(fromObjectType, fromObjectId, toObjectType) {
        try {
            const response = await hubspotClient.crm.associations.v4.basicApi.getPage(fromObjectType, fromObjectId, toObjectType, undefined, 100);
            return response.results.map(({ toObjectId }) => String(toObjectId));
        } catch (error) {
            console.error(`Failed to fetch ${toObjectType} associations for ${fromObjectType} ${fromObjectId}:`, error.message);
            return [];
        }
    }

    // Use the fetchAssociations function to retrieve line item associations for the parent deal
    const associatedLineItemsParent = await fetchAssociations('deals', parent_id, 'line_items');

    // Prepare inputs for cloning the filtered line items including associations directly in the batch creation
    const inputs = await Promise.all(associatedLineItemsParent.map(async (lineItemId) => {
        const lineItemResponse = await hubspotClient.crm.lineItems.basicApi.getById(lineItemId, [
            'name',
            'quantity',
            'price',
            // Add other necessary properties here
        ]);
        
        const properties = lineItemResponse.properties;
        // Exclude properties not needed for the clone or that should not be copied
        ['createdate', 'hs_lastmodifieddate', 'hs_object_id'].forEach(prop => delete properties[prop]);

        // Directly include the deal association in the input for the new line item
        const associations = OnceOffPayments_included || properties.recurringbillingfrequency !== null ? [{
            to: { id: hs_object_id },
            types: [
                {
                    associationCategory: "HUBSPOT_DEFINED",
                    associationTypeId: 20, // deals -> lineitems = 19, lineitems -> deals = 20
                },
            ],
        }] : [];

        return { 
            properties,
            associations
        };
    }));

    try {
        // Execute the batch create call including associations
        const apiResponse = await hubspotClient.crm.lineItems.batchApi.create({ inputs });
        console.log(JSON.stringify(apiResponse, null, 2)); // Log the API response for verification

        // Success callback
        callback({
            outputFields: {
                // Output fields here if necessary
            }
        });
    } catch (e) {
        console.error('Error:', e.message || 'An error occurred');
        callback({ error: e.message });
    }
};

Copying line items in custom code

Objective of this workflow

Prerequisites

Breakdown of the code

Step 1: Initialization and Setup

Step 2: Main Function Definition

Step 3a: Making Input Fields accessable

Step 3b: Retrieving Input Fields

Step 4: Fetching Associations with a Helper Function

Step 5: Cloning and Association Process

Step 6: Batch Creation of Cloned Line Items

Conclusion

Final code result