Connections > Zuora REST V2 connection properties
  

Zuora REST V2 connection properties

When you create a Zuora REST V2 connection, you must configure the connection properties.
The following table describes the Zuora REST V2 connection properties:
Property
Description
Runtime Environment
Runtime environment that contains Secure Agent used to access Zuora.
Authentication
Select ZuoraRESTV2.
Base Url
Endpoint URL of REST API to which you want to make calls. Do not specify the query parameters with the Base URL.
For example, https://rest.apisandbox.zuora.com/
Authentication Type
The type of user authentication to connect to the Zuora portal login. Select authentication method that the connector must use to login to the Zuora portal login.
You can select the following authentication types:
  • - Basic Auth
  • - OAuth 2.0
Default is OAuth 2.0.
Username
User name for the Zuora portal login. You must enter the username if you select Basic Auth as the Authentication Type.
Password
Password for the Zuora portal login. You must enter the password if you select Basic Auth as the Authentication Type.
Client ID
The client ID to complete the OAuth 2.0 authentication to connect to Zuora. You must enter the client ID if you select OAuth 2.0 as the Authentication Type.
Client Secret
The client secret key to complete the OAuth 2.0 authentication to connect to Zuora. You must enter the client secret key if you select OAuth 2.0 as the Authentication Type.
Grant Type
The type of authentication used to obtain the token. Use client_credentials.
Entity ID
When you have multiple entities in a single tenant, specify the entity ID to connect to a particular entity.
You can also specify the entity ID in the Request Message Editor. If you specify the entity ID in connection properties and Request Message Editor, entity ID specified in the connection properties takes precedence
Note: Entity ID is mandatory when you select OAuth 2.0 as the Authentication Type and specify custom fields in the Custom Field Config property.
Zuora API Version
Swagger file that you want to use for the Zuora REST V2 connection.
You can select the Zuora Swagger API V1_2017_09_06 or Zuora Swagger API V1_2018_08_23 swagger file.
Custom Field Config
Specify the name of the Zuora objects for which you want to configure custom fields as comma-separated values.
You can specify the following Zuora objects that support custom fields:
  • - Account
  • - Accounting Code
  • - Accounting Period
  • - Amendment
  • - Contact
  • - CreditBalanceAdjustment
  • - CreditMemoItem
  • - CreditMemo
  • - DebitMemoItem
  • - DebitMemo
  • - Feature
  • - InvoiceAdjustment
  • - InvoiceItemAdjustment
  • - InvoiceItem
  • - Invoice
  • - JournalEntryItem
  • - JournalEntry
  • - OrderAction
  • - Order
  • - Payment
  • - ProductFeature
  • - Product
  • - ProductRatePlanCharge
  • - ProductRatePlan
  • - RatePlanCharge
  • - RatePlan
  • - Refund
  • - RevenueEventItem
  • - RevenueEvent
  • - RevenueScheduleItem
  • - RevenueSchedule
  • - Subscription
  • - SubscriptionProductFeature
  • - TaxationItem
  • - Usage
Note: Applies only when you select the value of the Zuora API Version as Zuora Swagger API V1_2018_08_23.
For more information about Zuora objects that support custom fields, visit https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields/Objects_that_Support_Custom_Fields_in_Zuora.