Adjustment Summary
get
https://server:port/spl/rest/apis/customer/financials/adjustments/{adjustmentId}/summary
Request
Path Parameters
-
adjustmentId(required): string
Adjustment ID is the system-assigned, unique identifier of the adjustment.Example:
011163134133
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1AdjSumry
Type:
Show Source
object
-
account: object
account
-
accountingDate: string
(date)
Accounting Date
-
accountsPayableRequests: object
accountsPayableRequests
-
adjustment: object
adjustment
-
adjustmentAmount: number
Current Amount
-
adjustmentStatus: string
Allowed Values:
[ "05 ", "10 ", "20 ", "30 ", "50 ", "60 " ]
Adjustment Status shows the status of the transfer to adjustment. If you need to change the adjustment's status, use the action links. * `05 ` - New, * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - CanceledExample:30
-
adjustmentStatusDescription: string
(adjustmentStatusDescription)
-
adjustmentType: object
adjustmentType
Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.
-
approvalRequest: object
approvalRequest
-
calculationDate: string
(date)
Calculation date is used for a calculated adjustment type by the generated adjustment algorithm for any calculations that are effective dated. For example, rate version calculations group or bill factor values.Example:
2005-11-23
-
calculationDetails: object
calculationDetails
-
cancelReason: object
cancelReason
The Cancel Reason describes the reason for the cancelation.
-
canDelete: boolean
Delete to physically remove an Incomplete, Error or Freezable adjustment from the database.Example:
false
-
canGenerate: boolean
Generate a financial transaction for the adjustment. The financial transaction contains the adjustment's effect on the general ledger and on the customer's payoff and current balances.Example:
false
-
comments: string
Maximum Length:
254
Use the Comments to describe anything unique about the adjustment. -
creationDate: string
(date)
The Creation Date defines the date on which the adjustment was created.
-
currency: object
currency
-
financialTransactions: object
financialTransactions
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:GET
-
isCancel: boolean
Define Cancel as true to remove the financial effects of an adjustment. Canceling an adjustment causes the generation of another financial transaction. This new financial transaction reverses the financial impact of the original adjustment.Example:
false
-
isFrozen: boolean
Define Freeze as true to freeze the adjustment and its financial transaction, which also defines the adjustment's state becomes Frozen.Example:
false
-
isSubmit: boolean
Submit for ApprovalExample:
false
-
onBehalfSAId: string
Maximum Length:
10
On Behalf SA ID is only populated on system-generated adjustments instigated by one customer, but attributed to another customer. -
premise: object
premise
-
serviceAgreement: object
serviceAgreement
Service Agreement ID whose financial balance needs to be adjusted.
-
serviceAgreementType: object
serviceAgreementType
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.
-
serviceType: object
serviceType
Service Type defines the type of service associated with the SA type.
-
transferAdjustments: object
transferAdjustments
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID is the account to which the adjustment is linked.Example:1589800000
Nested Schema : accountsPayableRequests
Type:
Show Source
object
-
accountsPayableRequest: object
accountsPayableRequest
-
paidAmount: number
Paid Amount is the amount of the check. This field is only populated after accounts payable cuts the check.Example:
0.00
-
paymentDate: string
(date)
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
-
paymentNumber: string
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. -
paymentSelectionStatus: string
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 ` - CanceledExample:N
-
scheduledToPayDate: string
(date)
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:
Show Source
object
-
_link: string
_link
-
adjustmentId: string
Maximum Length:
12
Adjustment ID is the system-assigned, unique identifier of the adjustment.
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: string
_link
-
adjustmentType: string
Maximum Length:
8
Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.Example:CUSTREL
-
adjustmentTypeDescription: string
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:
Show Source
object
-
_link: string
_link
-
approvalRequestId: string
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 : cancelReason
Type:
object
The Cancel Reason describes the reason for the cancelation.
Show Source
-
_link: string
_link
-
cancelReason: string
Maximum Length:
4
The Cancel Reason describes the reason for the cancelation. -
cancelReasonDescription: string
Maximum Length:
100
The Cancel Reason describes the reason for the cancelation.
Nested Schema : currency
Type:
Show Source
object
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
premiseDescription: string
Maximum Length:
10
Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.Example:4000000099
-
premiseId: string
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
-
_link: string
_link
-
serviceAgreement: string
Maximum Length:
10
Service Agreement
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
-
_link: string
_link
-
division: string
Maximum Length:
5
CIS Division defines the jurisdiction that governs the account.Example:CA
-
divisionDescription: string
Maximum Length:
1
CIS Division defines the jurisdiction that governs the account.Example:CA
-
serviceAgreementType: string
Maximum Length:
8
CIS Division defines the jurisdiction that governs the account.Example:CA
-
serviceAgreementTypeDescription: string
Maximum Length:
30
CIS Division defines the jurisdiction that governs the account.Example:CA
Nested Schema : serviceType
Type:
object
Service Type defines the type of service associated with the SA type.
Show Source
-
_link: string
_link
-
serviceType: string
Maximum Length:
80
Service Type defines the type of service associated with the SA type.Example:E
Nested Schema : accountsPayableRequest
Type:
Show Source
object
-
_link: string
_link
-
autopayRequestId: string
Maximum Length:
12
A/P Request ID
Nested Schema : items
Type:
Show Source
object
-
calculationLines: object
calculationLines
-
endDate: string
(endDate)
-
rateVersion: object
rateVersion
-
startDate: string
(startDate)
Nested Schema : rateVersion
Type:
Show Source
object
-
_link: string
_link
-
effectiveDate: string
(date)
Effective Date
-
rateSchedule: string
Maximum Length:
8
Rate Schedule -
rateScheduleDescription: string
Maximum Length:
60
Description
Nested Schema : items
Type:
Show Source
object
-
calculatedAmount: number
Calculated Amount
-
descriptionOnBill: string
Maximum Length:
254
Description on Bill is the information about the calculation line that appears on the customer's bill.Example:Base Adjustment Amount
-
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence -
shouldAppearInSummary: boolean
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
-
shouldPrint: boolean
Define Print as true to print this line on the customer's bill.Example:
true
Nested Schema : items
Type:
Show Source
object
-
accountingDate: string
(date)
Accounting Date
-
arrearsDate: string
(date)
Arrears Date
-
bill: object
bill
-
billDate: string
(date)
Bill Date
-
currentAmount: number
Current Amount
-
financialTransaction: object
financialTransaction
-
payoffAmount: number
Payoff Amount
Nested Schema : bill
Type:
Show Source
object
-
_link: string
_link
-
billId: string
Maximum Length:
12
Bill ID
Nested Schema : financialTransaction
Type:
Show Source
object
-
_link: string
_link
-
financialTransactionId: string
Maximum Length:
12
Financial Transaction ID
Nested Schema : transferAccount
Type:
Show Source
object
-
_link: string
_link
-
transferAccountId: string
Maximum Length:
30
Account ID is the account to which the adjustment is linked.Example:0222222222
Nested Schema : transferAdjustment
Type:
Show Source
object
-
_link: string
_link
-
transferAdjustmentId: string
Maximum Length:
12
Transfer Adjustment ID is the system-assigned, unique identifier of the adjustment.
Nested Schema : transferPremise
Type:
Show Source
object
-
_link: string
_link
-
transferPremiseId: string
Maximum Length:
10
Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the transferred service agreement.
Nested Schema : transferServiceAgreement
Type:
Show Source
object
-
_link: string
_link
-
transferServiceAgreementId: string
Maximum Length:
30
Service Agreement ID defines the transfer to service agreement.
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
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. -
problemType: string
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: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
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. -
problemType: string
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: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.