Docs
You are viewing:
Product Catalog 2.0
This page helps you understand the objects and field mapping that is done between Chargebee and NetSuite.
Note
Source Entity - Chargebee Customer
Supported Actions - Create, Update
Unsupported Actions - Delete, Void.
The following table provides information on the customer object fields mapped between Chargebee and NetSuite:
| NetSuite Target Field, | Chargebee Source Field, | Additional information, |
entityId | id | A prefix is added if this field is configured. For example, If the prefix is CB-Customer and the customer id in Chargebee is 100 then the prefix will be synced as CB-Customer-100. If you have checked the Allow Override option in NetSuite, then Chargebee's identifiers will be set as the primary ID for Invoices, Credit Memos, Customers, and so on. If Allow Override is not set in NetSuite, then the value we've set in Chargebee will be ignored. |
external Id | id | A prefix is added if this field is configured. |
companyname | company or DefaultCompanyName | If isperson is set false, this field is not applicable |
customFieldList | Mapped as per the backend configuration made, else not applicable. | |
currency | preferredCurrencyCode | NetSuite Reference (The reference value from NetSuite is mapped to Chargebee here.) |
entitystatus | Mapped as per the configuration, otherwise left blank | NetSuite Reference (The reference value from NetSuite is mapped to Chargebee here.) |
subsidiary | Mapped as per the configuration | NetSuite Reference (The reference value from NetSuite is mapped to Chargebee here.) |
addressbookList | billingAddress | Refer to the NetSuite CustomerAddressbook section below for more details. |
firstname | firstName or DefaultFirstName | This field is applicable if isperson is set true. |
lastname | lastName or DefaultLastName | This field is applicable if isperson is set true. |
isperson | true | true if the customer company name is not present and has no contacts. |
email | email | |
phone | phone | |
vatRegNumber | vatRegNumber |
Customer Address Book in NetSuite is mapped as Billing address in Chargebee. Chargebee creates or appends customer billing address to NetSuite's customer address book.
Note
Source Entity - Chargebee Customer billing address
The following table provides information on the CustomerAddressbook object fields mapped between Chargebee and NetSuite:
| NetSuite Target Field | Chargebee Source Field | Additional information |
city | city | |
state | stateCode | |
zip | zip | |
country | country | |
addressee | fullname or companyName | Mapped based on the configurations made in the backend.Contact Chargebee Support for more help. |
addr1 | line1 | |
addr2 | line2 | |
addr3 | line3 |
In NetSuite, Item is the object name for Plans/Addons in Chargebee.
Note
Source entity - Chargebee Plans, Addons, and Item Prices
Supported actions - Create, Update
Unsupported actions - Delete, Void
The following table provides information on the NetSuite Item mapping done between Chargebee and NetSuite:
| NetSuite Target Field | Chargebee Source Field | Additional information |
externalId | sku or name | A prefix is added if this field is configured.If you have checked the Allow Override option in NetSuite, then Chargebee's identifiers will be set as the primary ID for Invoices, Credit Memos, Customers, and so on. If Allow Override is not set in NetSuite, then the value we've set in Chargebee will be ignored. |
itemid | sku or name | If sku value is present, the source field is mapped as sku, else mapped as name. A prefix is added if this field is configured. If you have checked the Allow Override option in NetSuite, then Chargebee's identifiers will be set as the primary ID for Invoices, Credit Memos, Customers, and so on. If Allow Override is not set in NetSuite, then the value we've set in Chargebee will be ignored. |
class | accountingCategory1 | Mapped based on Item level class or doc_level_tracking |
location | accountingCategory2 | Mapped based on Item level location or doc_level_tracking. |
department | accountingCategory3 | Mapped based on Item level department or doc_level_tracking |
revenueRecognitionRule | accountingCategory4 | Mapped based on Item level Revenue Recognition Rule Id |
revRecForecastRule | accountingCategory4 | Mapped based on Item level Revenue Recognition Rule Id |
taxSchedule | | NetSuite Reference (The reference value from NetSuite is mapped to Chargebee here.) |
incomeAccount | accountingCode | We will find matching account either by code or name. |
salesDescription | description | |
subsidiaryList | as per configuration |
Note
Source entity - Chargebee Invoice
Supported actions - Create, Update
The following table provides information on the Invoice mapping done between Chargebee and NetSuite:
| NetSuite Target Field | Chargebee Source Field | Comment |
billingAddress | billingAddress | Mapping is done as shown in the above NetSuite Address Mapping section. |
class | | Mapped as per the backend configuration made. |
currency | currencyCode | If the invoice currency is different from customer currency, then we will add the currency to the NetSuite customer and then set the currency reference. |
customFieldList | Mapped as per the configuration made, otherwise mapping is not applicable | |
department | | Mapped as per the backend configuration made. |
dueDate | dueDate | |
entityId | customerId | NetSuite Reference (The reference value from NetSuite is mapped to Chargebee here.) |
exchangeRate | exchangeRate | If use_tp_exchange_rate is configured, we will send a blank field and exchange rate will be handled in NetSuite. Chargebee's exchange rate will not be sent if this field is enabled. |
externalId | id | A prefix is added if this field is configured. |
itemList | lineItems | See the Item List section section shown below for more details |
location | | Mapped as per the backend configuration made. |
otherRefNum | poNumber | |
shippingAddress | shippingAddress | Mapping is done as shown in the above NetSuite Address Mapping section. |
taxDetailsOverride | true if override tax is configured | If true, Chargebee maps the tax information, else, NetSuite default mapping is followed. |
terms | Mapped as per the configuration made, otherwise left blank | Mapped based on the configurations made in the backend. |
tranDate | date | Mapped as invoice date. |
tranId | id | A prefix is added if this field is configured.If you have checked the Allow Override option in NetSuite, then Chargebee's identifiers will be set as the primary ID for Invoices, Credit Memos, Customers, and so on. If Allow Override is not set in NetSuite, then the value we've set in Chargebee will be ignored. |
In NetSuite, Credit Memo is the object name for Credit Notes in Chargebee.
Note
Source entity - Chargebee Credit Note Supported actions - Create, Update
| NetSuite Target Field | Chargebee Source Field | Additional information |
tranId | id | A prefix is added if this field is configured. If you have checked the Allow Override option in NetSuite, then Chargebee's identifiers will be set as the primary ID for Invoices, Credit Memos, Customers, and so on. If Allow Override is not set in NetSuite, then the value we've set in Chargebee will be ignored. |
externalId | id | A prefix is added if this field is configured. |
exchangeRate | exchangeRate | If use_tp_exchange_rate is configured, we will send a blank field and the exchange rate will be handled in NetSuite. |
class | doc_level_tracking or customer_level_tracking can be used. | Mapped as per the backend configuration. |
location | doc_level_tracking or customer_level_tracking can be used. | Mapped as per the backend configuration. |
department | doc_level_tracking or customer_level_tracking can be used. | Mapped as per the backend configuration. |
itemList | lineItems | Mapping is shown in the Item List section below. |
exchangeRate | exchangeRate | If use_tp_exchange_rate is configured, we will send a blank field and exchange rate will be handled in NetSuite. Chargebee's exchange rate will not be sent if this field is enabled. |
entityId | customerId | NetSuite Reference (The reference value from NetSuite is mapped to Chargebee here.) |
currency | currencyCode | NetSuite Reference (The reference value from NetSuite is mapped to Chargebee here.) |
setCreatedFrom | referenceInvoiceId | NetSuite Reference (The reference value from NetSuite is mapped to Chargebee here.) |
dueDate | dueDate | Not applicable for Credit Note. |
billingAddress | billingAddress | Not applicable for Credit Note.Mapping is done as shown in the NetSuite Address Mapping section above. |
shippingAddress | shippingAddress | Not applicable for Credit Note.Mapping is done as shown in the NetSuite Address Mapping section above. |
applyList | allocations | We will create or append to the applyList. |
taxDetailsOverride | true if override tax is configured | true if override tax is configured, else, NetSuite's default is followed. |
tranDate | date | |
otherRefNum | poNumber | |
autoApply | false | |
customFieldList | Mapped as per configuration, else mapping is not applicable. |
Line item-level tracking categories are automatically fed from the items created in NetSuite.
Note
Source entity - Chargebee Invoice / Credit Note Line Items
The following table provides information on the Line Item level mapping done between Chargebee and NetSuite:
| NetSuite Target Field | Chargebee Source Field | Comment |
ItemRef | entityId based line item entityType and entityId | If UseSalesAccount (as_per_sales) is not enabled, for ad-hoc cases, setup charges, bad_debts, discounts → default item that is created by Chargebee is used.We can also map to the existing item (For ad-hoc, setup charges, bad_debts, and discounts) in NetSuite. |
Description | description | This field is referred to as External Name on the Chargebee UI. |
Amount | amount | For tax inclusive cases, the amount is adjusted. |
Quantity | quantity | |
IsTaxable | true/false | Mapped based on tax details. |
TaxCode | Mapped based on the tax mapping and tax line item details. | |
customFieldList | Used for setting Advanced Revenue Management (ARM) start and end date.
| If Advanced Revenue Management (ARM) module is enabled, NetSuite supports start and end dates at line item level through custom fields of type date. |
Based on the transaction type, we will map the fields to either payment or refund to NetSuite.
Note
Source Entity - Chargebee Transaction
The following table provides information on the payment/refund field mapping done between Chargebee and NetSuite:
| NetSuite Target Field | Chargebee Source Field | Comment |
customer | customerId | NetSuite Reference (The reference value from NetSuite is mapped to Chargebee here.) |
tranId | id | A prefix is added if this field is configured. If you have checked the Allow Override option in NetSuite, then Chargebee's identifiers will be set as the primary ID for Invoices, Credit Memos, Customers, and so on. If Allow Override is not set in NetSuite, then the value we've set in Chargebee will be ignored. |
externalId | currencyCode | NetSuite Reference (The reference value from NetSuite is mapped to Chargebee here.) |
autoApply | false | |
payment | amount | Converted from cents to amount. |
checkNum | referenceNumber | |
memo | idAtGateway or referenceNumber | if idAtGateway is present,idAtGateway is mapped, else referenceNumber is mapped. |
account | Mapped based on configurations, currency, and paymentMethod. | Gateway + currency account mapping |
undepFunds | false | |
exchangeRate | exchangeRate | If use_tp_exchange_rate is configured, we will send a blank field and exchange rate will be handled in NetSuite. |
PaymentMethod | Mapped based on the payment method configuration. | |
TranDate | date | |
class | doc_level_tracking or customer_level_tracking can be used. | Mapped based on the backend configuration. |
location | doc_level_tracking or customer_level_tracking can be used. | Mapped based on the backend configuration. |
department | doc_level_tracking or customer_level_tracking can be used. | Mapped based on the backend configuration. |
customFieldList | Mapped based on the backend configuration, else left blank. | |
applyList | linkedInvoices, linkedCreditNotes, referenceTransactionId | payment uses linkedInvoices refund uses linkedCreditNotes and referenceTransactionId |
Was this article helpful?