Skip to main content

Synchronize Custom Fields

Zuora

Synchronize Custom Fields

  1. Last updated
  2. Save as PDF

Field mapping combinations are now available to synchronize custom fields to standard Zuora fields. Following are the field mapping available:

Source Target Custom -> Custom Standard -> Custom Custom -> Standard Standard -> Standard
Company  Account v v v v
Contact Contact  v v v v
Product Product v v v v
Product  ProductRatePlan v v v v
Product ProductRatePlanCharge v v v v
Deal Subscription v v - -

The Billing HubSpot connector facilitates the synchronization of custom fields from HubSpot to Zuora. This connector offers the flexibility to establish and modify field configurations. It's important to note that the synchronization of custom field data occurs solely during the creation of objects in Zuora. Subsequent updates to this data via the connector are not supported.

To specify the mapping of custom fields, populate the fieldMapping (optional) field within the Zuora connector's configuration page.

To configure custom fields, refer to the template below.

 [
    {
        "sourceObject": "<Object name in HubSpot>",
        "targetObject": "<Object name in Zuora",
        "fields": [
            {
                "source": "<Custom field Internal Name in HubSpot",
                "target": "<Custom field API Name in Zuora>"
            },
            {
                "source": "<Custom field Internal Name in HubSpot",
                "target": "<Custom field API Name in Zuora>"
            }
        ]
    }
]

To understand custom field configuration, refer to this example.

         [
    {
        "sourceObject": "Deal",
        "targetObject": "Subscription",
        "fields": [
            {
                "source": "deal_coolness",
                "target": "DealCoolness__c"
            },
            {
                "source": "deal_value",
                "target": "DealValue__c"
            }
        ]
    },
    {
        "sourceObject": "Contact",
        "targetObject": "Contact",
        "fields": [
            {
                "source": "message",
                "target": "crmOrderId__c"
            },
            {
                "source": "address",
                "target": "address2"
            },
            {
                "source": "address",
                "target": "IsCool__c"
            }
        ]
    }
]

To map to any target standard field in Zuora on any of the objects, the target field name must be the API name of the field as per the standard REST APIs.
For example, the API request payload uses the name notes to map to the Notes field in the account as per the REST API. See, Create an account. 

These mappings are supported both when the objects are created and during subsequent syncs to update the data.

Consider the HubSpot custom field name as the source and the API name of the standard field in Zuora as the target, as mentioned in the Zuora Billing API request. Here is an example you can refer to: https://developer.zuora.com/api-references/api/operation/POST_Account/. The API request payload uses the name notes to map to the Notes field in the account.