Retainers (Applied Customer Deposits) Field Mapping Definition

The Retainers (Applied Customer Deposits) import workflow includes one mapping group:

Retainer [Integration point: DEPOSIT_TO_RETAINER] — See Retainer Mapping Group.

Retainer Mapping Group

Use the Retainer mapping group to map information on retainer records in OpenAir with information about customer deposits applied to invoice transaction records in NetSuite. The mapping group supports filters.

For reference information and best practice guidelines, review the following topics:

References — Overview of record types in OpenAir and NetSuite with links to the relevant reference material for information about fields available for mapping.
Default and Custom Filters — Overview of default filters and how to modify the default behavior, and custom filters. Custom filters are supported for this mapping group.
Default Field Mappings — Overview of default field mapping definitions including notes and best practice guidelines where relevant. Information imported by default includes NetSuite invoice ID, customer internal ID in OpenAir, date, amount, notes, and currency. Filters are supported.
Additional Field Mappings — There are no specific guidelines for custom field mapping definitions in this mapping group.

References

The following table gives reference information about the records and fields available for custom field mapping definition with links to the relevant reference material. See also Schema Reference Documentation.

NetSuite Record type [`SOAP object`]	OpenAir Record Type [`table`]	Mapping Group [`Integration point`]
Customer Deposit [`CustomerDeposit`] Schema: CustomerDeposit (2020.1)\|CustomerDeposit (2023.1) XSD: `TransactionSearchRowBasic` — platformCommon (2020.1)\|platformCommon (2023.1)	Payment [`payment`] Data Dictionary: payment	Retainer [`DEPOSIT_TO_RETAINER`]

NetSuite Record type [SOAP object]

OpenAir Record Type [table]

Mapping Group [Integration point]

Customer Deposit [CustomerDeposit]

Schema: CustomerDeposit (2020.1)|CustomerDeposit (2023.1)

XSD: TransactionSearchRowBasic — platformCommon (2020.1)|platformCommon (2023.1)

Payment [payment]

Data Dictionary: payment

Retainer [DEPOSIT_TO_RETAINER]

Default and Custom Filters

By default, applied customer deposit records are imported from NetSuite into OpenAir if there is an invoice record in OpenAir matching the invoice record to which the customer deposit was applied in NetSuite.

Custom filters are supported for this mapping group. For more information about adding filter conditions, see Using Filters and Filter Definition.

Default Field Mappings

The following table describes the default field mapping definitions for the Retainer mapping group tab.

NetSuite Field	OpenAir Field	Notes
`Transaction.internalId`	`Payment.netsuite_retainer_id__c`	OpenAir NetSuite Connector stores the internal ID of the customer deposit in the NetSuite Applied Customer Deposit ID [`netsuite_retainer_id`] custom field on the retainer record in OpenAir. This custom field is used to link the OpenAir and NetSuite records for future updates and matching record associations.
Looked up OpenAir field value — `id` of OpenAir invoice record with `netsuite_invoice_id` equal to the NetSuite field `CustomerDepositApply.doc` from the `applyList` sublist.	`Payment.netsuite_deposit_applied_to_id__c`	The internal ID of the invoice to which the deposit is applied in NetSuite. A customer deposit can be applied to multiple invoices on the Apply subtab in NetSuite. Make sure you check only the box for the invoice corresponding to the OpenAir invoice to which you want to apply the retainer.
Looked up OpenAir field value — `id` of OpenAir customer record associated with the invoice with `netsuite_invoice_id` equal to the NetSuite field `CustomerPaymentApply.doc` from the `applyList` sublist.	`Payment.customer_id`	The internal ID of the customer record associated with the invoice to which the deposit is applied in NetSuite.
`CustomerDepositApply.applyDate`	`Payment.date`	The date the customer deposit was applied to the invoice in NetSuite.
`Transaction.appliedToLinkAmount`	`Payment.total`	The customer deposit amount.
`'NetSuite Customer Deposit ID #' + Transaction.internalId`	`Payment.notes`	[Initial Only] By default, the following content is added to the Notes field on the retainer record in OpenAir: `NetSuite Customer Deposit ID #` followed by the internal ID of the customer deposit transaction in NetSuite.
`Transaction.currency`	`Payment.currency`	Active and visible only if the Multicurrency feature is enabled for your OpenAir account. Multiple currency — The Currency on the retainer record in OpenAir is set to the Currency on the customer deposit transaction record in NetSuite.

NetSuite Field

Direction

OpenAir Field

Notes

Transaction.internalId

Payment.netsuite_retainer_id__c

OpenAir NetSuite Connector stores the internal ID of the customer deposit in the NetSuite Applied Customer Deposit ID [netsuite_retainer_id] custom field on the retainer record in OpenAir. This custom field is used to link the OpenAir and NetSuite records for future updates and matching record associations.

Looked up OpenAir field value — id of OpenAir invoice record with netsuite_invoice_id equal to the NetSuite field CustomerDepositApply.doc from the applyList sublist.

Payment.netsuite_deposit_applied_to_id__c

The internal ID of the invoice to which the deposit is applied in NetSuite.

A customer deposit can be applied to multiple invoices on the Apply subtab in NetSuite. Make sure you check only the box for the invoice corresponding to the OpenAir invoice to which you want to apply the retainer.

Looked up OpenAir field value — id of OpenAir customer record associated with the invoice with netsuite_invoice_id equal to the NetSuite field CustomerPaymentApply.doc from the applyList sublist.

Payment.customer_id

The internal ID of the customer record associated with the invoice to which the deposit is applied in NetSuite.

CustomerDepositApply.applyDate

Payment.date

The date the customer deposit was applied to the invoice in NetSuite.

Transaction.appliedToLinkAmount

Payment.total

The customer deposit amount.

'NetSuite Customer Deposit ID #' + Transaction.internalId

Payment.notes

[Initial Only] By default, the following content is added to the Notes field on the retainer record in OpenAir: NetSuite Customer Deposit ID # followed by the internal ID of the customer deposit transaction in NetSuite.

Transaction.currency

Payment.currency

Active and visible only if the Multicurrency feature is enabled for your OpenAir account.

Multiple currency — The Currency on the retainer record in OpenAir is set to the Currency on the customer deposit transaction record in NetSuite.

OpenAir NetSuite Connector updates automatically the OpenAir invoice record corresponding to the NetSuite invoice transaction to which the customer deposit is applied. The following information is updated:

Invoice.draw — total amount drawn against the retainer for the invoice.
Invoice.draw_date — the date of the draw.
Invoice.balance — outstanding balance on the invoice.

Additional Field Mappings

Important:

Review the following guidelines

You should contact your OpenAir Professional Services representative if you need to make changes to your integration configuration and field mapping definitions.
For advanced mapping usage and best practice guidelines, see Advanced Field Mapping Definition.
Familiarize yourself with the NetSuite and OpenAir technical documentation before attempting to set field mapping definitions using the advanced notation — See Schema Reference Documentation.

No specific guidelines