Adjustment View Request and Response - Attribute/Value Pairs in JSON Format
Note: We recommend you to refer the Adjustment View Request in the JSON Format and Adjustment View Response in the JSON Format topics
in parallel while understanding the below mentioned attributes. This
will help you to understand how the attribute/value pairs are structured
in the JSON format.
Before calling the C1-GetAdjustmentHistory business service through an inbound web service, you need to ensure that the adjustment view request contains the following attributes:
| Attribute Name | Attribute Description | Mandatory (Yes or No) |
|---|---|---|
| C1-GetAdjustmentHistory | Used to indicate that you want to invoke the C1-GetAdjustmentHistory business service. | Yes |
| getAdjRequest | Used to specify additional criteria along with the details of the account whose adjustments you want to view. | Yes |
| sourceSystem | Used to indicate the external system from which the adjustment
view request is sent. Note:
You must specify an external system which is already defined in the system. The external system is used when the Inbound Web Service History feature is enabled. The specified external system should match the external system which is associated with the outbound message type specified in the C1-IWSHIST algorithm. If the external system is not specified in the adjustment view request, the system, by default, stamps the external system associated with the outbound message type (specified in the C1-IWSHIST algorithm) corresponding to the record in the C1_IWS_HIST table. For more information, see Inbound Web Service History. |
No |
| externalSourceId | Used to specify the external source system ID. Note: The external
source system ID is used when the Inbound Web Service History feature is enabled.
|
No |
| c1ExternalTransactionId | Used to indicate the transaction in the external system through
which the adjustment view request is sent. Note: The external transaction
ID is used when the Inbound Web Service History feature is enabled.
|
No |
| billId | Used when you want to view adjustments which are created
against a particular bill. Note: You must specify a bill which already
exists in the system.
|
No |
| adjustmentType | Used when you want to view adjustments which are created
using a particular adjustment type. Note: You must specify an adjustment
type which is already defined in the system.
|
No |
| saType | Used when you want to view adjustments which are created
against contracts of a particular contract type. Note: You must specify
a contract type which is already defined in the system.
|
No |
| accountId | Used to indicate the account whose adjustments you want to view. | Yes (Conditional) Note: This data is required when the values
are not specified for the accountNumber, accountIdentifierType, and division attributes.
|
| division | Used to indicate the division to which the account belongs. Note: You must specify a division which is already defined in the system.
|
Yes (Conditional) Note: This data is required when the value
is not specified for the accountId attribute.
|
| accountNumber | Used to indicate the account whose adjustments you want to view. | Yes (Conditional) Note: This data is required when the value
is not specified for the accountId attribute.
|
| accountIdentifierType | Used to specify the account identifier type. Note: You must
specify an account identifier type which is already defined in the
system.
|
Yes (Conditional) Note: This data is required when the value
is not specified for the accountId attribute.
|
| adjustmentStatus | Used when you want to view adjustments with a particular
status. Note: You must specify a status which is already defined in
the ADJ_STATUS_FLG lookup field.
|
No |
| adjustmentFromDate | Used when you want to view adjustments which are created
from a particular date onwards. Note: The date should be earlier than
the date specified for the adjustmentToDate attribute.
|
Yes (Conditional) Note: This data is required when the value
is specified for the adjustmentToDate attribute.
|
| adjustmentToDate | Used when you want to view adjustments which are created
till a particular date. Note: The date should be later than the date
specified for the adjustmentFromDate attribute.
|
Yes (Conditional) Note: This data is required when the value
is specified for the adjustmentFromDate attribute.
|
Note: The date range specified through the adjustmentFromDate and adjustmentToDate attributes cannot exceed
365 days.
The following table lists and describes the attributes which appear in the adjustment view response in the JSON format:
| Attribute Name | Attribute Description |
|---|---|
| AdjustmentResponse | Indicates whether the adjustment view request is successfully processed or not. |
| statusCd | Indicates whether the adjustment view request is successfully
processed or not. The valid values are:
|
| messageText | Indicates the error that occurred while retrieving the adjustments
of the account. Note: This attribute appears when the value of the statusCd attribute is set to Fail.
|
| adjustmentList | Displays the details of an adjustment. |
| adjustmentId | Displays the adjustment ID. |
| adjustmentTypeCd | Indicates the adjustment type using which the adjustment is created. |
| adjustmentType | Displays the description of the adjustment type. |
| currency | Indicates the currency in which the adjustment is created. |
| currentAmount | Displays the adjustment amount. |
| adjustmentStatus | Indicates the status of the adjustment. The valid values
are:
|
| creDt | Displays the date when the adjustment is created in the system. |
Related Topics
| For more information on... | See... |
|---|---|
| Sample Adjustment View Request and Response in the JSON Format | Sample Adjustment View Request and Response in the JSON Format |