1. Oracle Utilities REST API for Metering and Customer Information
  2. Tasks
  3. Financial Transactions
  4. Adjustment

Adjustment Summary

get

https://server:port/spl/rest/apis/customer/financials/adjustments/{adjustmentId}/summary

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : C1AdjSumry
Type: object
Show Source
Nested Schema : account
Type: object
Show Source
Nested Schema : accountsPayableRequests
Type: object
Show Source
  • accountsPayableRequest
  • Paid Amount is the amount of the check. This field is only populated after accounts payable cuts the check.
    Example: 0.00
  • Payment Date is the date on which the check was cut by accounts payable. This field is only populated after accounts payable cuts the check.
    Example: 2005-11-23
  • Maximum Length: 36
    Payment Number is the system-assigned number of the payment in accounts payable, and this number typically appears on the printed check. This field is only populated after accounts payable cuts the check.
  • Allowed Values: [ "C ", "D ", "H ", "N ", "P ", "R ", "V ", "X " ]
    Payment Selection Status is the status of the check request. * `C ` - Closed, * `D ` - Negative Voucher Sum, * `H ` - Held, * `N ` - Not Selected for Payment, * `P ` - Paid, * `R ` - Requested for Payment, * `V ` - Convert Error, * `X ` - Canceled
    Example: N
  • Scheduled to Pay is the date on which the check is scheduled to be cut. This is equal to the adjustment date plus the Due Days on the adjustment type's accounts payable request type.
    Example: 2005-11-23
Nested Schema : adjustment
Type: object
Show Source
Nested Schema : adjustmentType
Type: object
Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.
Show Source
  • _link
  • Maximum Length: 8
    Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.
    Example: CUSTREL
  • Maximum Length: 60
    Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.
    Example: CUSTREL
Nested Schema : approvalRequest
Type: object
Show Source
  • _link
  • Maximum Length: 12
    Approval Request shows that the adjustment is subject to approval. Adjustments are required to be approved by one or more managers before they impact a customer's debt and the general ledger.
Nested Schema : calculationDetails
Type: object
Show Source
Nested Schema : cancelReason
Type: object
The Cancel Reason describes the reason for the cancelation.
Show Source
Nested Schema : currency
Type: object
Show Source
Nested Schema : financialTransactions
Type: object
Show Source
Nested Schema : premise
Type: object
Show Source
  • _link
  • Maximum Length: 10
    Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.
    Example: 4000000099
  • Maximum Length: 10
    Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.
    Example: 4000000099
Nested Schema : serviceAgreement
Type: object
Service Agreement ID whose financial balance needs to be adjusted.
Show Source
Nested Schema : serviceAgreementType
Type: object
Service Agreement Type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.
Show Source
Nested Schema : serviceType
Type: object
Service Type defines the type of service associated with the SA type.
Show Source
Nested Schema : transferAdjustments
Type: object
Show Source
Nested Schema : accountsPayableRequest
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : calculationLines
Type: object
Show Source
Nested Schema : rateVersion
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Calculated Amount
  • Maximum Length: 254
    Description on Bill is the information about the calculation line that appears on the customer's bill.
    Example: Base Adjustment Amount
  • Minimum Value: -99999
    Maximum Value: 99999
    Sequence
  • Define Appears in Summary as true to display this line's amount on a summary line. This switch plays a part at bill print time - those lines that appear in a summary print in the left dollar column, those that don't appear in a summary print in the right dollar column.
    Example: true
  • Define Print as true to print this line on the customer's bill.
    Example: true
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : bill
Type: object
Show Source
Nested Schema : financialTransaction
Type: object
Show Source
Nested Schema : transferAccount
Type: object
Show Source
Nested Schema : transferAdjustment
Type: object
Show Source
Nested Schema : transferPremise
Type: object
Show Source
Nested Schema : transferServiceAgreement
Type: object
Show Source

400 Response

Bad Request
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • Maximum Length: 60
    Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
  • Maximum Length: 60
    URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
  • serverMessage
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • Maximum Length: 60
    Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
  • Maximum Length: 60
    URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
  • serverMessage
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top