GoCardless for NetSuite FAQs
Bulk requesting mandate links
There are 2 options for bulk requesting mandate links for your customers in NetSuite:
- Use a CSV import to set the required GoCardless fields when creating and/or updating customer records
- Use NetSuite’s API to set the required GoCardless fields when creating and/or updating customer records
To bulk request mandate links using one of these methods, you’ll need to populate the following GoCardless fields. See the “NetSuite customer - GoCardless input” section for more information on how these fields are used.
|
FIELD NAME (CSV) |
FIELD ID (API) | DESCRIPTION |
REQUIRED? |
|---|---|---|---|
| GoCardless configuration |
custentity_ns_gc_config |
Set to the internal ID of the GoCardless configuration record. |
Y |
| Autopay with GoCardless |
custentity_ns_gc_integrate_to_celigo |
When it's set to T, the customer's invoices will have the "Pay with GoCardless" checkbox selected by default. When it's set to F, the customer's invoices will have the "Pay with GoCardless" checkbox deselected by default. |
N |
| Send mandate link automatically |
custentity_ns_gc_send_link_auto |
When this field is set to T, a link to the online mandate form will be emailed to the customer once it’s generated using the below email template & email address fields. When it’s set to F, the link won’t be sent to the customer once it’s generated. |
N (Y if emailing link) |
| Mandate Email Template | custentity_ns_gc_mandateemailtemplate | Set to the internal ID of the email template that will be used to send the mandate link to the customer when the "Send mandate link automatically" field is selected. |
N (Y if emailing link) |
|
Mandate link email address |
custentity_ns_gc_mandate_link_mail | Set to the recipient email address that will be used when the "Send mandate link automatically" field is selected. If this field isn't populated, the email address populated on the NetSuite customer in the "Email | Phone | Address" section will be used. If neither is populated & “Send mandate link automatically” is set to T, an error will be thrown. |
N (Y if emailing link) |
| Selected GoCardless currency | custentity_ns_gc_select_gc_cur | Set to the currency for the mandate. This should be the 3 letter ISO 4217 currency code. If your NetSuite account has the multi-currency feature enabled, the currency should be enabled on the “Financial” tab of this customer & it should be one of the supported GoCardless currencies. | Y |
|
Redirect URI |
custentity_ns_gc_redirect_uri | (optional) Set to the redirect URI where the customer will be redirected after they’ve completed the mandate set up through the generated link. If it’s left blank, the customer will remain on a “Success” page. | N |
|
Mandate link requested |
custentity_ns_gc_mand_link_requested | Set to T to trigger the creation of the mandate link for the customer. If the Currency isn’t populated, the flow to generate the link will not be triggered. | Y |
Creating mandates via the GoCardless API
This integration supports creating mandates directly through the GoCardless API. The mandate will automatically sync into NetSuite against the relevant customer record as long as the NetSuite internal customer ID is passed as metadata on the GoCardless mandate using the “nscust” key. This enables additional use cases such as custom payment pages, VRP mandates, PayTo mandates, and Verified Mandates.
Creating mandates via the GoCardless Dashboard
This integration supports creating mandates directly through the GoCardless dashboard. The mandate will automatically sync into NetSuite and can be found on the GoCardless > Mandates > Mandate page. From here, you can edit the mandate record & assign it to the related NetSuite customer.
Creating payments via the GoCardless API or dashboard
This integration supports creating payments directly through the GoCardless API or dashboard. The payment will automatically sync into NetSuite against the relevant invoice record as long as the NetSuite internal invoice ID is passed as metadata on the GoCardless payment using the “invoiceId” key. This enables additional use cases such as one-off Instant Bank Payments.
Credit memo handling
The integration is able to handle credits when they're applied to invoices before the GoCardless payment is initiated. For example,
- If a full credit is applied to the invoice before the GoCardless payment is initiated using the "Pay with GoCardless" checkbox, the invoice would not be processed by GoCardless as it would be marked as "Paid in full" with a 0 outstanding balance.
- If a partial credit is applied to the invoice before the GoCardless payment is initiated using the "Pay with GoCardless" checkbox, the outstanding balance on the invoice would be collected via GoCardless once the checkbox is selected.
Therefore, if a credit needs to be applied to an invoice, save the invoice without “Pay with GoCardless” selected to apply the credit. Once the amount is adjusted as a result of the credit being applied, save the invoice with “Pay with GoCardless” selected to process the payment.