- Home /
- Working in m3ter - User Guides /
- Integrations /
- Setting Up and Managing Native and Notification Integrations
Configuring NetSuite Integrations
You can define and manage native integrations for sending your end customer Account Bills generated in m3ter outbound into your NetSuite system:
First, create the integration.
Second, set up authentication for the integration to connect with NetSuite.
This topic also includes a section designed to help you set up NetSuite in preparation for connecting and authenticating your m3ter integration with your NetSuite instance:
Lastly, a reference section sets out the mappings for a m3ter - NetSuite integration:
Creating the Integration
You can quickly set up a native NetSuite integration in the Console.
Notes:
Tip: Reviewing Integration Runs! When you've set up an integration with NetSuite for your Organization in your production environment, you can review details of the integration runs performed for the integration. See Reviewing Integration Run Details.
Warning: Credit or Debit Line Items on Bills! If you are using NetSuite's Advanced Revenue Module (ARM) and have added Credit or Debit line items to Bills, then please ensure you enter Service Period start and end dates for these line items. This is a NetSuite requirement when using ARM and a Bills integration will not run correctly if you omit these dates.
To define a m3ter - NetSuite integration:
1. Select Integrations:
The Integrations page opens with All selected by default.
2. Select Netsuite:
The Integrations>NetSuite page opens.
3. On the Configurations panel, select Configure new integration>Configure bill integration:
The Create page opens and the Entity type - Bill and External system - NetSuite are shown at the top of the page.
4. Use the Global configuration panel to:
Enter a Name for the Integration. This is required and is useful if you intend to create multiple Integrations for the same External system/Entity Type and need to clearly differentiate them.
Select the Accounts you want the integration to apply to:
Account ids. Select the Accounts you want to include - all selected Accounts are treated as allowed for the integration.
Restricted account ids. Select the Accounts you want to exclude - all selected Accounts are treated as not allowed for the integration.
Notes:
If you want to include all Accounts in the integration, leave both Accounts ids and Restricted account ids empty.
Any filtering by Account ids you define using these settings to control which Accounts the integration runs for will be in addition to any filtering you define using the Account filter option - see the following step for Entity Configuration options.
Select Users for Email notifications if disabled:
Integration disabled notification users. Select Organization Users you want to receive an Email notification if the integration is automatically disabled.
Notes:
An integration is automatically disabled if there have been 10 successive previous error Event responses to earlier attempts to run the integration. See Reviewing and Resolving Integration Events for more details.
If you select Organization Users to receive an Email notification when the integration is automatically disabled, their User id will be listed under Configuration Data on the Integration Details page.
5. Use the Entity configuration panel to configure the m3ter entity you will be synchronizing with for the integration. In the case of an outbound Bill integration, this entity will be the Bill generated for a customer Account in m3ter:
Only send bill on approval. Enable this if you only want Bills to be sent when they have been approved. If disabled, the Bill will be sent every time it is regenerated. Default is disabled. Note that:
The frequency of Bills sent will depend on the billing frequency defined for the Account Plan attached to the Account - such as daily/weekly/monthly/annually.
If an Account has a Prepayment on it and the billing for Prepayment fees is configured to run on a customized schedule, Bills will be sent when scheduled Bills are generated.
If a Bill is manually recalculated the updated Bill will be sent.
If you enable this, then the integration will not run for all Bill Jobs.
Use external mapping account code. Enable this if you want the integration to look in the External Mappings for the Account identifier, which means you can use an external Id. If this is disabled, the m3ter Account Id is used. Default is disabled.
Excluded line item types. Filter the Bill line items you send to the destination system. For example, only send charges or credits and exclude all other line items.
For details of line item types, see Bill Line Item Types.
Warning: Credit and Debit line items on Bills! If you are using the NetSuite Advanced Revenue Module (ARM) and you've set up the integration to include CREDIT_MEMO and DEBIT_MEMO line items and you have added Credit or Debit line items to Bills, please ensure you enter service period start and end dates for these line items. This is a NetSuite requirement when using the ARM and if you omit these dates, the integration will not run correctly. See Adding Credit Line Items to Bills and Adding Debit Line Items to Bills.
Account filter. Optionally, enter an expression that is run on the Account to determine whether or not the integration is run. You can use this setting if you have multiple destinations for sending Bills outbound to your NetSuite system. For example:
customFields != null AND customFields.country = = UKIn this example, the integration will run for an Account only if you have created a Custom Field for the Account called country and given the field a value of UK.
Notes:
Other Account fields for Account filter expression? You can reference other fields on the Account object in the Account filter expression. For details and another example, see Managing Multiple Third Party Destinations for Integrations.
Additional filtering? Any global filtering you define using the settings to include/exclude Accounts for integration runs by Account ids will be in addition to any filtering you define using the Account filter option - see the previous step for Global Configuration.
Enforce external mappings for config. Optionally enable this if you want the integration to use only those external mappings specified as being for this configuration.
Use this setting if you want to set up multiple integrations for the same external system. You can then create separate external mappings for each integration from the details page of each integration, and these external mappings become Linked external mappings for the specific integration. See Creating Linked External Mappings.
6. Use the External system configuration panel to enter the settings specific to the external system. These settings include field mappings as well as other system-specific configurations:
Split usage line items. Select how you want to split line items in the outgoing Bill. Two options:
Item per usage band. Create a line item on your NetSuite invoice for each pricing band.
Item per product. Create one NetSuite Item per m3ter Bill Item.
Netsuite send due date. Whether the calculated due date is sent from m3ter to NetSuite. If this option is disabled, NetSuite will default the due date based on the customer configuration.
Netsuite commitment item id. Enter the Id of the Commitment item in NetSuite. This field is only required if you are representing Commitments with a specific NetSuite Item. If not configured, the NETSUITE_DEFAULT_ITEM_ID will be used.
Netsuite minimum spend id. Enter the Id of the Minimum Spend in NetSuite. This field is only required if you are representing Minimum Spends with a specific NetSuite Item. If not configured, the NETSUITE_DEFAULT_ITEM_ID will be used.
Netsuite default item id. Enter the Id of the Default item in NetSuite. This will be used if there is no External Mapping entity configured in m3ter between m3ter and NetSuite - for example "Other".
Netsuite item mapping. Enter the details for mapping each Bill line item type to their corresponding items in NetSuite. Optionally map each line item type in m3ter with a specific Item in NetSuite. These values will be used if there is no external mapping for a NetSuite Item. For any of these fields which are not populated, the value in NETSUITE_DEFAULT_ITEM_ID will be used as the default for that line item type.
For details of line item types, see Bill Line Item Types.
Netsuite item custom field mapping. Optionally choose a specific mapping to NetSuite Custom fields. Currently, there are only two fields for a line item available for mapping to NetSuite Custom fields:
servicePeriodStart
servicePeriodEnd
Sort line items by. Optionally, select a property to sort line items by before they are sent out to the external system. Three options:
None
Subtotal
Aggregation ID
7. Select Create integration. You are taken to the details page for the integration, where you can immediately complete the configuration by setting up authentication to allow the integration to connect with your NetSuite system - see the following Setting Up Authentication section for details:
Note that if you are not ready to continue your workflow and set up authentication immediately, you can do this at a later time.
Setting Up Authentication for the Integration
When you have created a NetSuite integration, you can select an Integration Credential you've created for authentication allowing the integration to connect with your NetSuite system:
Note that if you've followed the workflow given in the earlier section for creating the integration, on creation you'll be taken directly to the Integration Details page to continue and immediately set up authentication. The procedure described in this section assumes you've returned at a later date to set up authentication for the integration - the main steps you need to follow if you're setting up authentication immediately after creation are the same.
To set up authentication for your m3ter - NetSuite integration:
1. Select Integrations. The Integrations page opens.
2. Select NetSuite. The Integrations>NetSuite page opens.
3. On the Configurations panel, select the Name hotlink text of the NetSuite integration you want to set up authentication for. The Integration details page opens:
Notes:
A warning is shown that the integration is not yet connected to your NetSuite system.
The ID of the integration configuration is shown at the bottom of the Integration details card, and you can copy the ID directly to your clipboard.
4. Select Connect credential. A Select credential modal appears.
5. Select a Credential you created earlier and want to use to authenticate the integration with NetSuite. See Creating NetSuite Integration Credentials.
6. Select Confirm. The modal closes and on Integrations details, the integration now shows as CONNECTED:
If at any time you want to disconnect the integration, select Disconnect credential.
If you want to use a different Credential for connecting the integration, select Change credential. The Select credential modal appears and you can select a different Credential.
Tip: Integrations API Calls? When you have set up your NetSuite integration, you can review and manage the integration using a full set of API Calls. See the Integrations section of our API Reference Docs.
Completing Prerequisites and Setting Up your NetSuite System
This section provides guidance on completing necessary prerequisites and setting up Netsuite in preparation for connecting and authenticating your m3ter integration with your NetSuite instance to allow m3ter to send out Bills to NetSuite:
Important - Please consult your NetSuite Documentation! The instructions given in this section for setting-up your NetSuite system to prepare for an outbound Bill integration with m3ter are intended for guidance only. We do not hold ourselves responsible for any changes made by NetSuite, and strongly recommend that you consult the NetSuite end user documentation as you perform this configuration and treat the NetSuite documentation as authoritative.
Completing Prerequisites
There are two prerequisites tasks you'll need to complete:
Creating New Role and User for the Integration
For your NetSuite instance, you'll first have to complete the following:
1. Go to Setup>Company>Enable Features:
Select the SuiteCloud tab.
Select the option for OAuth 2.0.
Accept the OAuth 2.0 Terms and Conditions.
2. Go to Setup>Users/Role>Manage Roles>New:
Create a new Role for the m3ter integration. This Role will need read access to Customer/Items and read/write access to Invoices.
Select the option for Web Services Only Role.
Select Save.
3. Go to Setup>Users/Roles>Manage Users>New:
Create a new User for the m3ter integration that uses the m3ter integration Role you’ve just created.
4. Go to the Custom>List, Records & Fields>Transaction Column Fields>New. This opens Transaction Line Field.
5. Enter a LABEL, such as m3ter External ID.
6. Enter the ID as: _m3ter_external_line_item.
This will create a custom field for transactions called: custom_m3ter_external_line_item.
7. Check that the TYPE setting is Free-Form Text.
8. Under Applies to check SALE ITEM.
9. Select Save and Apply to Forms.
Generating Key Pair Using OpenSSL
This section explains how to generate a new key pair using OpenSSL. You'll generate the m3ter-cert certificate for upload into your NetSuite, and the corresponding m3ter-key that the Integration will be using to authenticate when synching data.
Tip: Windows User? If you are a Windows user, OpenSSL will not be installed automatically and you will have to install it to complete this section. Here is a website with instructions on how to install openssl that you might want to use to help you do this.
1. Open a command line terminal window on your local machine.
2. Enter and run the following command:
1openssl req -new -x509 -newkey rsa:4096 -keyout m3ter-key.pem -sigopt rsa_padding_mode:pss -sha256 -sigopt rsa_pss_saltlen:64 -out m3ter-cert.pem -nodes -days 7302
3. When the command runs, you'll be asked to enter some details:
Country name
Organization
Email address
Two files are generated in the current directory.
4. Perform a list command to check. Two files should be listed:
m3ter-cert. This certificate will be uploaded to NetSuite.
m3ter-key. This private key will be loaded into m3ter.
Tip: Note that you'll be able to delete these key pair files from your local machine later.
Configuring NetSuite
Having completed the prerequisites, you can now proceed to configure your NetSuite instance.
1. Go to Setup>Integration>Manage Integrations>New:
Enter a NAME - for example: m3ter Integration - and a DESCRIPTION.
Unselect the options for TOKEN-BASED AUTHENTICATION, TBA: AUTHORIZATION-FLOW, and AUTHORIZATION CODE GRANT.
Under OAuth 2.0:
Select the option for CLIENT CREDENTIALS (MACHINE TO MACHINE) GRANT.
Under SCOPE, select the options for:
RESTLETS
REST WEB SERVICES
SUITEANALYTICS CONNECT
2. Select Save. Under Client Credentials, you'll see your credentials appear:
CONSUMER KEY / CLIENT ID
CONSUMER SECRET / CLIENT SECRET
Warning! Note the NetSuite warning that these credentials will be displayed only once - ensure you copy and save these locally before you leave this page. If you fail to record them, you can re-open the page for the new integration and select Reset Credentials.
3. Go to Setup>Integration>OAuth 2.0 Client Credentials (M2M) Setup:
4. Select Create New. This opens the Create a New Client Credentials Mapping modal:
ENTITY is the user you want to grant access for.
ROLE is Administrator.
APPLICATION is m3ter Integration for this example.
Under CERTIFICATE, select Choose a file. A select file dialog opens. Locate and select the m3ter-cert file. The chosen file will then show as selected.
5. Select Save. The Create a New Credentials Mapping modal closes.
6. Back on the OAuth 2.0 Client Credentials (M2M) Setup page, copy and save the CERTIFICATE ID.
7. Copy and save the URL prefix of your NetSuite instance. For example:
1234555567-sb1.app.netsuite.com
You can now open your m3ter Organization and perform the required set up work there - see the following section.
Configuring m3ter
You can set up authentication for your m3ter NetSuite integration to connect with your NetSuite instance through the m3ter Console as described in the above section and using the Netsuite Connection modal:
On the modal, enter the settings for authentication with your NetSuite system for the integration:
Account Id. Enter the NetSuite Account Id. You can find this on the Setup>Company>Company Information page in the NetSuite console.
Warning! Sandbox Account Id - use hyphen: If you are setting up in your NetSuite Sandbox, the Account Id field will need to use an hyphen character instead of an underscore. For example, 12345-SB instead of 12345_SB.
Client Id. Enter the m3ter Integration Client ID, which was available when the integration was set up in the NetSuite console.
Certificate Id. The Certificate ID. You can obtain this from the Setup>Integrations>OAuth 2.0 Client Credentials Setup page in the NetSuite console.
Upload Netsuite Credentials. Allows you to upload a private key - click Browse and select the m3ter-key.pem you created under Key Pair Generation above using OpenSSL.
Mappings
This reference section sets out the mappings for a m3ter - NetSuite integration:
Bill
| m3ter | NetSuite Invoice | Notes |
|---|---|---|
| accountId | Customer Id | External Mapping |
| billId | invoice id | External Mapping |
| dueDate | dueDate | Start of day |
| endDateTimeUTC | endDate | |
| purchaseOrderNumber | PoNumber | |
| sequentialInvoiceNumber | tranid | |
| startDateTimeUTC | startDate |
Bill Line Item
| m3ter Line Item | NetSuite Invoice Item | Notes |
|---|---|---|
| convertedSubTotal | amount | (1) Rounded to two decimal places or whatever is set for the billing currency. (2) Depends on Split usage line item setting for the integration: (i) converted SubTotal is mapped if Item per product is selected or if the setting is not configured; (ii) If Item per usage band is selected, then bandSubTotal is mapped instead. |
| description | description | |
| id | externalId | |
| quantity | quantity | |
| pricingBandId | ItemId | External mapping: mapped to ItemId only if Item per usage band is selected for Split usage line items setting. |
| productId | ItemId | External mapping: mapped to ItemId only if Item per product is selected for Split usage line items setting. |
| rate | rate |
Next: Managing Multiple Third Party Destinations for Integrations
Additional Support
Login to the Support portal for additional help and to send questions to our Support team.