Adjustment Creation Request and Response - Attribute/Value Pairs in JSON Format

Note: We recommend you to refer the Adjustment Creation Request in the JSON Format and Adjustment Creation 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-CreateAdjustment business service through an inbound web service, you need to ensure that the adjustment creation request contains the following attributes:

Attribute Name Attribute Description Mandatory (Yes or No)
C1-CreateAdjustment Used to indicate that you want to invoke the C1-CreateAdjustment business service. Yes
adjustmentRequest Used to specify the details of the adjustment. Yes
accountNumber Used to indicate the account for which you want to create the adjustment. Yes (Conditional)
Note: This data is required when:

  • The matchTypeCd attribute is set to CNTY.

  • No value is specified for the accountId attribute.
accountNumberTypeCd 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 matchTypeCd attribute is set to CNTY.

  • No value is specified for the accountId attribute.
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 matchTypeCd attribute is set to CNTY.

  • No value is specified for the accountId attribute.
accountId Used to indicate the account for which you want to create the adjustment. Yes (Conditional)
Note: This data is required when:

  • The matchTypeCd attribute is set to CNTY.

  • No value is specified for the accountNumber, accountNumberTypeCd, and division attributes.
matchTypeCd Used to indicate the match type using which you want to identify the contract against which the adjustment should be created. The valid values are:

  • CNTY - Used when you want to derive an active contract which is created using the specified contract type on the account. The system then adjusts the contract value of the account through the adjustment.

    Note: If there are multiple active contracts of the specified contract type on the account, the system will derive the contract with the latest start date.

  • CONT - Used when you want to specify the contract whose value should be adjusted through the adjustment.

 Yes
matchTypeValue If the matchTypeCd attribute is set to CNTY, this attribute is used to specify the contract type. However, if the matchTypeCd attribute is set to CONT, this attribute is used to specify the contract ID.
Note: You must specify a contract type or contract which is already defined in the system.
 Yes
comment Used to specify additional information about the adjustment. No
billId Used to indicate the previous completed bill against which you want to create the adjustment.
Note:

You must specify a bill which already exists in the system.

The bill and contract should belong to the same account.

The system allows you to create an adjustment against a bill when the Print by Default option is selected in the adjustment type.

 No
currencyCd Used to indicate the currency in which you want to create the adjustment.
Note:

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

If you do not specify the currency, by default, the adjustment is created in the account's invoice currency.

If the specified currency is different from the account's invoice currency, the system does the currency conversion and creates the adjustment in the account's invoice currency.

 No
adjustmentType Used to indicate the adjustment type using which you want to create the adjustment.
Note:

You must specify an adjustment type which is already defined in the system.

You must ensure that the adjustment type is included in the adjustment type profile which is associated with the contract type.

 Yes
currentAmount Used to specify the adjustment amount.
Note:

If you do not specify the amount, by default, it is set to zero(0).

The adjustment amount's precision must match the precision (decimal positions) defined for the currency.

 No
arrearsDate Used to specify the date from when the adjustment's financial transaction should start aging.
Note: If you do not specify the date, by default, it is set to the date when the adjustment's financial transaction is created.
 No
accountingDate Used to specify the date using which you want the system to determine the financial transaction's accounting period in the general ledger.
Note: If you do not specify the date, by default, it is set to the date when the adjustment's financial transaction is created.
 No
sourceSystem Used to indicate the external system from which the adjustment creation 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 creation 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
externalTransactionId Used to indicate the transaction in the external system through which the adjustment creation request is sent.
Note: The external transaction ID is used when the Inbound Web Service History feature is enabled.
 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
adjustmentCharacteristics Used to specify a characteristic for the adjustment. No
characteristicType Used to indicate the characteristic type.
Note: You must specify a characteristic type where the characteristic entity is set to Adjustment and which is associated with the adjustment type.
 Yes (Conditional)
Note: This data is required while defining a characteristic for the adjustment.
characteristicValue Used to specify the value for the characteristic type. Yes (Conditional)
Note: This data is required while defining a characteristic for the adjustment.

The following table lists and describes the attributes which appear in the adjustment creation response in the JSON format:

Attribute Name Attribute Description
adjustmentResponse Indicates whether the adjustment creation request is successfully processed or not.
adjustmentId Displays the adjustment ID.
adjustmentStatus Indicates the status of the adjustment. The valid values are:

  • Freezable

  • Frozen

The following table indicates the scenarios in which the adjustment is set to the Freezable or Frozen status:

If... Then...
An approval profile is specified in the adjustment type The adjustment status is set to Freezable.
An approval profile is not specified in the adjustment type, but the adjustment freeze option in the adjustment type is set to Freeze At Bill Completion The adjustment status is set to Freezable.
An approval profile is not specified in the adjustment type, but the adjustment freeze option in the adjustment type is set to Freeze At Will The adjustment status is set to Frozen.
saId Indicates the contract against which the adjustment is created.
adjustmentAmount Displays the adjustment amount.
approvalRequestId Displays the approval request ID.
Note: The value for this attribute appears when the approval profile is set in the adjustment type using which the adjustment is created.
messageText Indicates the error that occurred while creating the adjustment.
Note: This attribute appears when the value of the statusCd attribute is set to Fail.
statusCd Indicates whether the adjustment creation request is successfully processed or not. The valid values are:

  • Success

  • Fail

Related Topics

For more information on... See...
Sample Adjustment Creation Request and Response in the JSON Format Sample Adjustment Creation Request and Response in the JSON Format