Introduction
This document describes the various screens and pages on RMS UI.
Upload Tax Rule Mappings
...
This screen is uploading hsn tax rule mappings. This is required when tax rules are not passed in the compute tax API calls
Click on the download template button to get a sample csv file. The csv file will be like below:
...
Set the hsn values and the tax rule mapped to them.
Click on “Choose File” and select the file where you updated the hsn tax rule mappings.
Click on the upload button. The hsn tax rule mappings have been added to RMS.
Search HSN Tax Rule Mappings
...
In this screen, you can see the hsn tax rule mappings uploaded in the previous section.
It will be displayed in a tabular format
Add/Update Customers
...
In this screen, you can add/update customers. Customer addition is required when you want the TCS tax amount to be computed also.
On clicking the “+” button, the add customer window opens
...
Enter the form details here
Customer Name: Name of the customer
Customer PAN: The Pan number of the customer
Active? : If the customer is active or not
TCS Tax rate: The TCS tax rate to be applied for TCS Calculation
Click on the add button to add the customer details
Invoice Config
...
In this screen, you can add the invoice prefix and series
On clicking the “+” button, the add invoice config window opens
...
Enter the form details here:
Invoice Prefix - The invoice prefix that will be used for generating the invoice id in RMS
Invoice Id - The invoice series from which the invoice id generated will start. For example, if the invoice prefix is ‘INCREFF-’ and invoice Id is set as 1, then the first invoice id would be INCREFF-1, the next invoice id would be INCREFF-2 and so on.
Invoice Alias - As there can be multiple invoice configurations for a single organization, this field is used to identify them. It can be any text.
E Invoicing enabled? - If the invoices to be generated are to be E Invoices
Invoice Template- Which template to be used while generating invoice. The standard invoice template is “invoice.fo.vm” which has to be selected if the client wants the invoice to be printed in the standard format that we have.
Click on the Add button to add the invoice configuration.
Once added, it will be displayed in a tabular format on the Invoice Config page.
Credit Note Config
...
In this screen, you can add the credit note prefix and series
On clicking the “+” button, the add credit note config window opens
...
Enter the form details here:
Credit Note Prefix - The invoice prefix that will be used for generating the credit note id in RMS
Credit Note Id - The credit note series from which the credit note id generated will start. For example, if the credit note prefix is ‘INCREFF-’ and credit note Id is set as 1, then the first credit note id would be INCREFF-1, the next credit note id would be INCREFF-2 and so on.
Credit Note Alias - As there can be multiple credit note configurations for a single organization, this field is used to identify them. It can be any text.
E Invoicing enabled? - If the invoices to be generated are to be E Invoices
Credit Note Template- Which template to be used while generating credit note. The standard invoice template is “credit-note-template.fo.vm” which has to be selected if the client wants the credit note to be printed in the standard format that we have.
Click on the Add button to add the credit note configuration.
Once added, it will be displayed in a tabular format on the Credit Note Config page.
Clickpost Config
...
In this screen, you can add the clickpost credentials to be used for generating shipping label
On clicking the “+” button, the add clickpost config window opens
...
Enter the form details here:
Clickpost Username- Clickpost username to be used in the Clickpost API calls. You can get this from Clickpost team.
Clickpost API Key- Clickpost API key to be used in the Clickpost API calls. You can get this from Clickpost team.
Clickpost Webhook Key - The webhook which will be used by Clickpost to push notifications to RMS. To get this
Login to Client’s Clickpost Panel. Clickpost dashboard link:
Go to Settings
Go to the Notification tab
Beside the webhook field, there is a “generated key” field. This is your Clickpost Webhook Key.
Clickpost Account Alias - As there can be multiple clickpost configurations for a single organization, this field is used to identify them. It can be any text.
Notifications Enabled? - This should be set as true if the client wants Clickpost to push notifications to RMS, otherwise it should be false. If it is set as true, then the push url and credential configuration must also be done on the Push Config page.
Click on the Add button to add the clickpost configuration.
Once added, it will be displayed in a tabular format on the Clickpost Config page.
Shiprocket Config
...
In this screen, you can add the shiprocket credentials to be used for generating shipping label
On clicking the “+” button, the add shiprocket config window opens
Enter the form details here:
Shiprocket Username- Shiprocket email to be used in the Shiprocket API calls. You can get this from Shiprocket team.
Shiprocket Password- Shiprocket Password to be used in the Shiprocket API calls. You can get this from Shiprocket team.
Shiprocket Webhook Key - The webhook which will be used by Shiprocket to push notifications to RMS. To get this
Login to Client’s Shiprocket Panel. Shiprocket dashboard link:
Go to Settings
In the API section, click on Webhooks
There is a “token” field. This is your Shiprocket Webhook Key.
Shiprocket Account Alias - As there can be multiple shiprocket configurations for a single organization, this field is used to identify them. It can be any text.
Notifications Enabled? - This should be set as true if the client wants Shiprocket to push notifications to RMS, otherwise it should be false. If it is set as true, then the push url and credential configuration must also be done on the Push Config page.
Click on the Add button to add the shiprocket configuration.
Once added, it will be displayed in a tabular format on the Shiprocket Config page.
Push Credentials Config
...
In this screen, you can configure the push url and credentials. The push url is the url where RMS will make the API call to send the notification to the client’s system.
On clicking the “+” button, the add push config credentials window will open.
...
Enter the header name and header values here. These will be passed as headers when RMS makes the notification API call to the client’s system.
Reports
...
In this screen, you can download the reports for the taxes computed, invoices generated and shipping labels generated.
In the start date and end date fields, select the date range for which the reports are to be generated.
Select the type of report you want to download
Tax Report
Invoice Report
Shipping Label report
Click on the search button for the details to be displayed on the UI.
Click on the download button for the details to be downloaded in CSV format.