Prospect Account Update Request and Response - Attribute/Value Pairs 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 update request contains the following attributes:
Attribute Name | Attribute Description | Mandatory (Yes or No) |
---|---|---|
mainEntityId | Used to specify the person whose prospect account you want to update. | Yes |
mainEntityType | Used to indicate whether the person is an existing person
or a prospect person whose prospect account you want to update. The
valid values are:
|
Yes |
actionFlag | Used to indicate that you want to create request to update
a prospect account. The valid value is:
Note: If you do not specify the value in this attribute, by default,
the system considers it as an ADD action.
|
Yes |
prospectAccountId | Used to specify the prospect account whose details you want to update. | Yes |
status | Used to indicate the current status of the prospect account.
Note:
You can change the status of the prospect account from ACTIVE to INACTIVE while updating. You can change the status of a prospect account from INACTIVE to ACTIVE only when the status of the existing or prospect person to whom the prospect account belongs is ACTIVE. If you do not specify the value in this attribute, the system considers it as an 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 |
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:
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.
|
At a time, you can update only one prospect account of the existing or prospect person through the C1_PRSACCT_SERVICE business service.
When you create a request to update a prospect account, the system replaces the prospect account data instead of editing it. Therefore, you should provide all details of the prospect account including the data that you want to change.
Once the prospect account is updated, all the details of prospect account are listed in the above mentioned attributes.
Related Topics
For more information on... | See... |
---|---|
Sample prospect account update request and response in the JSON format | Sample Prospect Account Update Request and Response in the JSON Format |