Payment Transaction Sync
Overview
This integration syncs payments applied to one or more invoices to and from NetSuite payments with Zuora. The payment integration is implemented as two separate syncs: Zuora payments to NetSuite and NetSuite payments to Zuora.
About the Payment Transaction Sync
Custom fields will be added to the NetSuite payment object:
- Only processed payments will be synced to NetSuite.
- One payment may be applied to one or more invoices.
- No actual credit card data will be synced in either direction.
- The accounting code for the payment is determined by the payment method and is configured and maintained manually within the associated NetSuite Payment Method.
- Payments that are voided or cancelled before they are transferred to accounting will not be synced.
- A payment that has been transferred to accounting cannot be voided.
- Overpayments are not supported.
Review the Transaction Sync Preferences. These preferences are important, and control the behavior and data mapping of the sync, including the payment number.
Transaction Sync Notes
- Either payment sync can be disabled completely from the NetSuite Connector Advanced Settings. However, you should disable this only under the guidance of Zuora Services.
- The NetSuite Payment sync is disabled by default. To enable it, go to the NetSuite Connector Advanced Settings.
- The Zuora Payment sync will not execute if Zuora does not calculate taxes (if the NetSuite Connector Advanced Setting for Use Standard Invoice Sync is
false
). - If there is an error in Invoice sync or Credit Memo sync, the Payment sync is not triggered because payments are linked to invoices and credit memos.
- Payment transaction syncs will fail if the currency of the customer account on the NetSuite side is changed.
Payment Transaction Sync Rules: Zuora to NetSuite
This process syncs Zuora payments to NetSuite customer payments.This integration syncs records according to the following rules:
- Zuora Payment records are synced if they meet the following criteria:
- The related customer account option Sync To NetSuite is not set or set to
Yes
. - The Status is
Processed
. - The Transferred to Accounting status is
No
,Error
, orProcessing
. - The Effective Date is greater than or equal to the Payment Cutover Date (if the value is specified in the NetSuite Connector Advanced Settings).
- The integration status field in the account must be “Sync Complete” enabled.
- The related customer account option Sync To NetSuite is not set or set to
- The following validations are performed during the sync to ensure data integrity:
- The Zuora payment method matches a valid NetSuite payment method. See Reconcile Data Between Zuora and NetSuite for more information.
- The associated Zuora invoices have been synced (they have an IntegrationId).
- If populated, the associated Zuora account's NetSuite location matches a valid NetSuite location.
- If populated, the associated Zuora account's NetSuite class matches a valid NetSuite class.
- If populated, the associated Zuora account's NetSuite department matches a valid NetSuite department.
- The Zuora payment’s Integration Status is updated to
Creating Payment
and Transferred to Accounting is updated toProcessing
to indicate the record is currently being synced and to assist with error recovery. - If the Zuora payment is applied to more than one invoice, the NetSuite payment will also be applied to multiple invoices.
- Upon successful creation of the NetSuite payment, the new NetSuite internal ID is written back to the Zuora payment record, the Integration Status is set to
Sync Complete
, and Transferred to Accounting is set toYes
.
Sync Notes
- Once synced successfully, no further changes to the Zuora payment will be synced, including cancellations. If you need to resync a payment, you can manually delete the NetSuite payment and set the Zuora payment’s Transferred to Accounting to
No
. However, if a payment is voided or canceled before it is picked up by the sync, the payment will be ignored. - Transferred to Accounting values of
Null
in the API will appear asNo
in the Zuora UI. - See NetSuite Classifications for information about how classifications are mapped for NetSuite transaction header and details.
- Credit card data is not transferred.
- Unapplied Payments in Zuora will not sync to NetSuite while in an unapplied state unless the record has already been synced while having an application against it.
- With Invoice Settlement enabled, if a payment is synced to NetSuite successfully, then the payment will not be synced again when transferring to another customer account or recording as unassigned.
Deposit-To Account Information
The Deposit-To account is where the payment amount will be placed. This is determined by the Deposit-To account configured on the referenced payment method within NetSuite. NetSuite Connector does not use the Accounting Code field on the Zuora payment method.
Payment Transaction Sync Flow: Zuora to NetSuite
Payment Transaction Sync Rules: NetSuite to Zuora
This process syncs NetSuite customer payments applied to one or more Zuora invoices to Zuora payments.
This integration syncs records according to the following rules:
- NetSuite payment records are synced if they meet the following criteria:
- The related customer account must be synced (the Zuora Customer ID cannot be empty).
- The payment’s Integration Status is not
Sync Complete
. - The payment is fully applied (the Amount Remaining is 0).
- The Zuora Origin is not
ZUORA
. - The payment is applied to at least one invoice that came from Zuora (where transaction type is
invoice,
Zuora Type isINVOICE
, and Zuora ID is not empty).
If you are not using Netsuite connector to sync Zuora invoices to Netsuite. If you use Workflow to sync the Invoice and create a payment in Netsuite using those invoices, you must manually update the custom field Zuora Type toINVOICE
if the payment is applied to invoices.
- The following validations are performed during the sync to ensure data integrity:
- The associated Zuora invoice has been synced (it has an IntegrationID).
- The NetSuite payment method matches a valid Zuora payment method.
- The NetSuite payment’s Integration Status is updated to
Creating Payment
to indicate the record is currently being synced and to assist with error recovery. - If the NetSuite payment is applied to more than one Zuora invoice, the Zuora payment will also be applied to multiple invoices. This is done by creating a Zuora payment in
Draft
status, adding each invoice reference, then updating the payment status toProcessed
. - If exclusiveTaxNoRounding or inclusiveTaxNoRounding permissions were enabled before activating Invoice settlement, the Billing Invoice total balance may differ from the total balance of Invoice Item/Taxation Item. This discrepancy could potentially result in failed payment synchronization.
- After creating the Zuora payment successfully, the new Zuora ID is written back to the NetSuite payment record and the Integration Status is set to
Sync Complete
.
Sync Notes
- The NetSuite to Zuora Payments sync uses a different connection type to the rest of the connector and therefore requires that its credentials are set manually within Boomi. Contact Zuora Global Support for access to Boomi and for instructions on how to implement these changes. The credentials submitted are the same OAuth credentials used to authenticate with Zuora so it is recommended to make note of those values when they are generated.
- Once synced successfully, any additional changes to the NetSuite payment will not be synced, including cancellations and deletions. If you need to resync a payment, you must manually cancel the Zuora payment and clear the Integration Status and Zuora ID fields on the NetSuite payment.