Home > FAQs > How to write a server script to calculate the outstanding invoice amount?

FAQs in this section

What is VTAP? What tools VTAP provides? What is Module Designer? What is API Designer? Where can I find documentation for VTAP? Which editions and version supports VTAP? What is the pricing of VTAP? What happens to customization done using Customizer in V7 version? How to get in touch with Platform team? What is the intent of Developer edition? What is Vtiger’s Add-on Publisher? Is Add-ons Publisher available in all the CRM editions? How do I publish Email Template add-ons? How do I publish any other module as an add-on? How do I update a published add-on? How do I test an add-on? What are the limitations of the Add-ons Publisher? Which different add-on features can I publish? What can a developer publish using Add-on Publisher? What are the conditions for updating a published add-on? What are the prerequisites for publishing an add-on? What is an Insights Designer? What is the use of Insigts Designer in Vtiger CRM? What are the queries in Insights Designer? What are the components of the Insight Designer? What are the components of a Widget in Insights Designer? What is the Input tab in Insights Designer? What is the Transfer tab in Insights Designer? What is the Output tab in Insights Designer? What are the benefits of using the Insights Designer? How do I access the Insights Designer in Vtiger CRM? How do I create an Insights page? How do I enable filters for a report? How do I pin an Insight to the Dashboard? Is Raw Query support available by default? In which editions of Vtiger CRM is the VTAP - App Creator available? Can I set access to my custom apps? What are Line Item Fields in Insights Designer? What are Server Scripts and Jobs in Vtiger CRM? What is a Server Script? What are Server jobs? How do I create a Server job? What are the different helper methods to write server scripts? What is the Debugging method to write Server scripts? What are HTTP methods to write server scripts? What is Vtiger REST API method to write server scripts? How to write code for Server Scripts and Jobs? How to write a script for a server job to update stocks weekly in the warehouse system? How to write a script for a server job for importing daily leads from a file? How to write a server script to set case SLA by created day? How to write a server script for contact email validation and data enrichment? how to write a server script to update the credit score of a contact? How can I delete a UI component in the Module Designer?

How to write a server script to calculate the outstanding invoice amount?

Consider that CompanyX provides marketing services to multiple organizations. They regularly get marketing projects from their client companies. To manage marketing invoices, they use CRM.
They have a certain set of fixed clients for whom they do marketing campaigns regularly. For each campaign, they generate an invoice for the client. At any point in time, they want to see for each client what is the outstanding invoice amount.
For this, they create a custom currency field in the Organization to store overdue invoice amounts. Next, they create a workflow to update this amount whenever the Invoice amount is changed or the status is changed.

async function main(record, user) {
    //Get organization id from invoice
var orgId = record.account_id ? record.account_id.id : false;
if(orgId) {
try {
//Fetch all related invoices for organization using rest api
var relatedRes = await vtap.macro.ws.api('GET', 'retrieve_related', {
     id: '3x'+orgId,
     relatedLabel: 'Invoice',
     relatedType: 'Invoice'
     });
     if(relatedRes && relatedRes.success) {
     var overdueAmount = 0;
     //For each related invoice, sum the balance amount
     for(var index in relatedRes.result) {
     var invoice = relatedRes.result[index];
     var balance = parseFloat(invoice.balance);
     if(balance && !isNaN(balance)) {
     overdueAmount = overdueAmount + balance;
     }
     }
     //Round off the amount to 8 decimal digits
     overdueAmount = Math.round(overdueAmount * 100000000) / 100000000;

     //Update outstanding amount to organization using rest api revise method
     await vtap.macro.ws.revise({
     id: '3x'+orgId,
     cf_outstanding_invoice_amount: overdueAmount
     });
     }
} catch(error) {

}
}
}

Explanation

From invoice getting organization id.
For that organization, getting all related invoices using the rest API method retrieve_related.
Summing the balance amount of each invoice.
Using the rest API revise method, the overdue amount of all related invoices is updated to the organization's custom currency field.

Was this FAQ helpful?

0 out of 0 found this helpful.

Comments 0

Be the first to comment

FAQs in this section

How to write a server script to calculate the outstanding invoice amount?

Table of Contents

Comments 0