Prospect Account Add Request and Response - Attribute/Value Pairs in the JSON Format

Note: We recommend you to refer the topics Prospect Account Add Request in the JSON Format and Prospect Account Add Response in the JSON Format in parallel while understanding the below mentioned attributes. This will help you to understand how the attribute/value pairs are nested in the JSON format.

Before calling the C1_​PRSACCT_​SERVICE business service through an inbound web service, you need to ensure that the prospect account add request contains the following attributes:

Attribute Name Attribute Description Mandatory (Yes or No)
mainEntityId Used to specify the person for whom you want to add the prospect account. Yes
mainEntityType Used to indicate whether the person is an existing person or a prospect person for whom you want to add the prospect account. The valid values are:

  • MAIN

  • PRSP

 Yes
actionFlag Used to indicate that you want to create request to add a prospect account. The valid value is:

  • ADD

Note: If you do not specify the value in this attribute, by default, the system considers it as an ADD action.
 Yes
status Used to indicate the status of the prospect account.

  • ACTIVE

  • INACTIVE

Note:

While adding a prospect account, the status of the prospect account can only be set to ACTIVE.

If you do not specify the value in this attribute, by default, the system considers it as ACTIVE status.

 No
customerClass Used to indicate the customer class to which the prospect account belongs.
Note: You must specify a customer class which is associated with the division to which the prospect account belongs.
 Yes
accountDivision Used to indicate the division to which the prospect account belongs.
Note:

You must specify a division which is already defined in the system.

You must specify a division to which the prospect account and the person belongs (i.e. the division of the prospect account and the person for whom the account is added should be the same).

If you do not specify the division, by default, the system considers the division to which the person belongs.

 Yes
setUpDate Used to specify the date from when the prospect account is configured for the person. Yes
currency Used to indicate the currency which you want to use for generating the invoice of the prospect account.
Note: You must specify a currency which is already defined in the system and which is associated with the division to which the prospect account belongs.
 Yes
billCycle Used to indicate the time interval in which you want to generate the bills for the prospect account. Yes (Conditional)
Note: This data is required while defining the prospect account.
accountAccessGroup Used to indicate the user group who can view and edit the details of the prospect account.
Note:

If you do not specify the value in this attribute, the system considers the access group of the person to whom the account belongs.

You must specify an access group which is associated with the division to which the prospect account and the person belongs.

 Yes
prosAcctCharacteristicList Used to specify a list of characteristics for the prospect account. No
characteristicValue Used to specify the value for the characteristic type. Yes (Conditional)
Note: This data is required while defining a characteristic for the prospect account.
effectiveDate Used to specify the date from when the characteristic is effective for the prospect account. Yes (Conditional)
Note: This data is required while defining a characteristic for the prospect account.
characteristicType Used to indicate the characteristic type.
Note: You must specify a characteristic type which is associated with the division to which the prospect account belongs.
 Yes (Conditional)
Note: This data is required while defining a characteristic for the prospect account.
prosAcctIdentifierList Used to specify a list of identifiers for the prospect account. No
accountIdentifierType Used to indicate the identifier type based on which you want to define the prospect account.
Note:

If you specify the accountNumber attribute, you need to specify the accountIdentifierType attribute.

You must specify an identifier type which is associated with the division to which the prospect account belongs.

 Yes (Conditional)
Note: This data is required while associating an identifier with the prospect account.
isPrimaryId Used to indicate whether the prospect account identifier is primary or not. The valid values are:

  • True

  • False

Note: If you do not specify the value in this attribute, the system considers the value as False.
 Yes (Conditional)
Note: This data is required while associating an identifier with the prospect account.
accountNumber Used to specify the value of the identifier type using which you want to add the prospect account.
Note: If you specify the accountIdentifierType attribute, you need to specify the accountNumber attribute.
 Yes (Conditional)
Note: This data is required while associating an identifier with the prospect account.
Note:

At a time, you can add only one prospect account for the person through the C1_​PRSACCT_​SERVICE business service.

If the prospect account status is INACTIVE in the system, you must set the action flag as UPD while adding the prospect account through the inbound web service.

Once the prospect account is created, all the details of prospect account are listed in the above mentioned attributes along with the following attribute:

Attribute Name Attribute Description
prospectAccountId Displays the prospect account identification number.

Related Topics

For more information on... See...
Sample prospect account add request and response in the JSON format Sample Prospect Creation Request and Response in the JSON Format