Create Adjustment
post
https://server:port/spl/rest/apis/customer/financials/adjustments/
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
accountingDate: string
(date)
Accounting Date
-
accountsPayableRequests: object
accountsPayableRequests
-
adjustmentId: string
Maximum Length:
12
Adjustment ID is the system-assigned, unique identifier of the adjustment. -
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
-
adjustmentType: object
adjustmentType
Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.
-
amount: number
Current Amount
-
approvalRequest: object
approvalRequest
-
baseAmount: number
Current Amount
-
calculatedAmount: number
Calculated Amount is the calculated amount associated with the calculation line.
-
calculationDate: string
(date)
Calculation date is used for a calculated adjustment type by the generate adjustment algorithm for any calculations that are effective dated (e.g., rate version calculation group or bill factor value).Example:
2005-11-23
-
calculationDetails: object
calculationDetails
-
cancel: boolean
(isCancel)
-
cancelReason: object
cancelReason
If the status is canceled, the Cancel Reason is displayed.
-
characteristics: object
characteristics
-
comments: string
Maximum Length:
254
Use the Comments to describe anything unusual about the adjustment. -
creationDate: string
(date)
The Creation Date defines the date on which the adjustment was created.
-
currency: object
currency
-
delete: boolean
(canDelete)
-
financialTransactions: object
financialTransactions
-
freeze: boolean
(isFrozen)
-
generate: boolean
(canGenerate)
-
nextActions: object
nextActions
-
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.
-
submitForApproval: boolean
(isSubmit)
-
transferAdjustments: object
transferAdjustments
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : account
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID is the account to which the adjustment is linked.Example:1589800000
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
-
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
Nested Schema : approvalRequest
Type:
Show Source
object
-
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
If the status is canceled, the Cancel Reason is displayed.
Show Source
-
cancelReason: string
Maximum Length:
4
If the status is canceled, the Cancel Reason is displayed.
Nested Schema : premise
Type:
Show Source
object
-
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
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
Nested Schema : items
Type:
Show Source
object
-
account: object
account
-
address1: string
Maximum Length:
254
The first line of the address.Example:1 Speedwell
-
address2: string
Maximum Length:
254
The second line of the address.Example:Morristown
-
address3: string
Maximum Length:
254
The third line of the address. -
address4: string
Maximum Length:
254
The fourth line of the address. -
autopayRequest: object
autopayRequest
-
city: string
Maximum Length:
90
The city of the address.Example:San Francisco
-
country: object
country
-
county: string
Maximum Length:
90
The county of the address.Example:San Francisco
-
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house if applicable for the address. * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
isInCityLimit: boolean
In City Limit switch is on if the address is considered within the physical city limits.Example:
false
-
paidAmount: number
Paid Amount is the amount of the check. This field is only populated after A/P cuts the check.Example:
0.00
-
paymentCurrency: object
paymentCurrency
-
paymentDate: string
(date)
Payment Date is the date on which the check was cut in A/P. This field is only populated after A/P cuts the check.Example:
2005-11-23
-
paymentNumber: string
Maximum Length:
36
Payment Number is the system-assigned number of the payment in A/P (this number typically appears on the printed check). This field is only populated after A/P 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
-
postal: string
Maximum Length:
12
The postal code of the address.Example:07960
-
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 A/P request type.Example:
2005-11-23
-
state: string
Maximum Length:
6
The state of the address.Example:CA
-
streetNumber1: string
Maximum Length:
6
The first street number line of the address. -
streetNumber2: string
Maximum Length:
4
The second street number line of the address. -
taxVendorGeographicalCode: string
Maximum Length:
11
Geographic code used to apply proper taxation rules to the physical address location.
Nested Schema : autopayRequest
Type:
Show Source
object
-
autopayRequestId: string
Maximum Length:
12
A/P Request ID
Nested Schema : paymentCurrency
Type:
Show Source
object
-
paymentCurrency: string
Maximum Length:
3
Currency Code
Nested Schema : items
Type:
Show Source
object
-
_data: array
_data
-
effectiveDate: string
(date)
Effective Date
-
rateSchedule: string
Maximum Length:
8
Rate Schedule
Nested Schema : items
Type:
Show Source
object
-
auditCalculatedAmount: number
Minimum Value:
-1.0E13
Maximum Value:1.0E13
Calculated Amount is the calculated amount associated with the calculation line.Example:1.23000
-
baseAmount: number
Base Amount
-
billableServiceQuantity: number
Minimum Value:
-1.0E12
Maximum Value:1.0E12
Billable Service Quantity is the service quantity priced on the calculation line. This quantity differs from the measured consumption if there are pre-processing calculation groups in effect.Example:1.230000
-
characteristicType: object
characteristicType
-
characteristicValue: string
Maximum Length:
16
Characteristic Value Indicates the value of the characteristic. -
currency: object
currency
-
description: string
Maximum Length:
100
Description describes the characteristic value that was used when the line's amount was calculated. This information is only displayed if the line was calculated using a bill factor (because only bill factors use characteristic values). -
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
-
distributionCode: object
distributionCode
-
exemptAmount: number
Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.Example:
0.00
-
measuresPeakQuantity: boolean
Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.Example:
false
-
rateCompSequence: number
Minimum Value:
-9999
Maximum Value:9999
Sequence -
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence is the system-assigned unique identifier of the calculation detail row.Example:1
-
serviceQuantityIdentifier: object
serviceQuantityIdentifier
-
shouldAppearInSummary: boolean
The Appears in Summary switch defines if this line's amount also appears 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
The Print switch controls whether information about this line will print on the customer's bill.Example:
true
-
timeOfUse: object
timeOfUse
-
unitOfMeasure: object
unitOfMeasure
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : distributionCode
Type:
Show Source
object
-
distributionCode: string
Maximum Length:
10
Distribution Code
Nested Schema : serviceQuantityIdentifier
Type:
Show Source
object
-
serviceQuantityIdentifier: string
Maximum Length:
30
SQI
Nested Schema : unitOfMeasure
Type:
Show Source
object
-
unitOfMeasure: string
Maximum Length:
30
Unit of Measure
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
typeOfCharacteristicValue: string
Maximum Length:
4
Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference. -
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:2
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
accountingDate: string
(date)
Accounting Date
-
arrearsDate: string
(date)
Arrears Date
-
billId: string
Maximum Length:
12
Bill ID -
currentAmount: number
Current Amount
-
financialTransaction: object
financialTransaction
-
payoffAmount: number
Payoff Amount
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : financialTransaction
Type:
Show Source
object
-
financialTransactionId: string
Maximum Length:
12
Financial Transaction ID
Nested Schema : items
Type:
Show Source
object
-
_link: string
(_link)
-
actionName: string
(actionName)
Nested Schema : items
Type:
Show Source
object
-
adjAmt2: number
Transfer Adjustment AmountExample:
0.00
-
adjStatusFlg2: string
Maximum Length:
10
Adjustment Status shows the status of the transfer to adjustment. -
comments2: string
Maximum Length:
100
Use the Comments to describe anything unusual about the adjustment. -
creDt2: string
(date)
Creation Date defines the date on which the adjustment was created.
-
transferAccount: object
transferAccount
-
transferAdjustmentId: string
Maximum Length:
12
Transfer Adjustment ID is the system-assigned, unique identifier of the adjustment. -
transferAdjustmentType: object
transferAdjustmentType
-
transferCurrency: object
transferCurrency
-
transferFinancialTransactions: object
transferFinancialTransactions
-
transferPremise: object
transferPremise
-
transferServiceAgreement: object
transferServiceAgreement
-
version: number
Minimum Value:
0
Maximum Value:0
Version2
Nested Schema : transferAccount
Type:
Show Source
object
-
transferAccountId: string
Maximum Length:
30
Account ID 2
Nested Schema : transferAdjustmentType
Type:
Show Source
object
-
transferAdjustmentType: string
Maximum Length:
8
Transfer Adjustment Type
Nested Schema : transferCurrency
Type:
Show Source
object
-
transferCurrency: string
Maximum Length:
30
Currency Code 2
Nested Schema : transferPremise
Type:
Show Source
object
-
transferPremiseId: string
Maximum Length:
10
Transfer Premise ID
Nested Schema : transferServiceAgreement
Type:
Show Source
object
-
transferServiceAgreementId: string
Maximum Length:
30
Service Agreement ID 2
Nested Schema : items
Type:
Show Source
object
-
arrearsDate: string
(date)
Arrears Date
-
bill: object
bill
-
currentAmount: number
Current Amount
-
financialTransaction: object
financialTransaction
-
payoffAmount: number
Payoff Amount
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : financialTransaction
Type:
Show Source
object
-
financialTransactionId: string
Maximum Length:
12
Financial Transaction ID
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
accountingDate: string
(date)
Accounting Date
-
accountsPayableRequests: object
accountsPayableRequests
-
adjustmentId: string
Maximum Length:
12
Adjustment ID is the system-assigned, unique identifier of the adjustment. -
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
-
adjustmentType: object
adjustmentType
Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.
-
amount: number
Current Amount
-
approvalRequest: object
approvalRequest
-
baseAmount: number
Current Amount
-
calculatedAmount: number
Calculated Amount is the calculated amount associated with the calculation line.
-
calculationDate: string
(date)
Calculation date is used for a calculated adjustment type by the generate adjustment algorithm for any calculations that are effective dated (e.g., rate version calculation group or bill factor value).Example:
2005-11-23
-
calculationDetails: object
calculationDetails
-
cancel: boolean
(isCancel)
-
cancelReason: object
cancelReason
If the status is canceled, the Cancel Reason is displayed.
-
characteristics: object
characteristics
-
comments: string
Maximum Length:
254
Use the Comments to describe anything unusual about the adjustment. -
creationDate: string
(date)
The Creation Date defines the date on which the adjustment was created.
-
currency: object
currency
-
delete: boolean
(canDelete)
-
financialTransactions: object
financialTransactions
-
freeze: boolean
(isFrozen)
-
generate: boolean
(canGenerate)
-
nextActions: object
nextActions
-
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.
-
submitForApproval: boolean
(isSubmit)
-
transferAdjustments: object
transferAdjustments
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : account
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID is the account to which the adjustment is linked.Example:1589800000
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
-
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
Nested Schema : approvalRequest
Type:
Show Source
object
-
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
If the status is canceled, the Cancel Reason is displayed.
Show Source
-
cancelReason: string
Maximum Length:
4
If the status is canceled, the Cancel Reason is displayed.
Nested Schema : premise
Type:
Show Source
object
-
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
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
Nested Schema : items
Type:
Show Source
object
-
account: object
account
-
address1: string
Maximum Length:
254
The first line of the address.Example:1 Speedwell
-
address2: string
Maximum Length:
254
The second line of the address.Example:Morristown
-
address3: string
Maximum Length:
254
The third line of the address. -
address4: string
Maximum Length:
254
The fourth line of the address. -
autopayRequest: object
autopayRequest
-
city: string
Maximum Length:
90
The city of the address.Example:San Francisco
-
country: object
country
-
county: string
Maximum Length:
90
The county of the address.Example:San Francisco
-
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house if applicable for the address. * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
isInCityLimit: boolean
In City Limit switch is on if the address is considered within the physical city limits.Example:
false
-
paidAmount: number
Paid Amount is the amount of the check. This field is only populated after A/P cuts the check.Example:
0.00
-
paymentCurrency: object
paymentCurrency
-
paymentDate: string
(date)
Payment Date is the date on which the check was cut in A/P. This field is only populated after A/P cuts the check.Example:
2005-11-23
-
paymentNumber: string
Maximum Length:
36
Payment Number is the system-assigned number of the payment in A/P (this number typically appears on the printed check). This field is only populated after A/P 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
-
postal: string
Maximum Length:
12
The postal code of the address.Example:07960
-
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 A/P request type.Example:
2005-11-23
-
state: string
Maximum Length:
6
The state of the address.Example:CA
-
streetNumber1: string
Maximum Length:
6
The first street number line of the address. -
streetNumber2: string
Maximum Length:
4
The second street number line of the address. -
taxVendorGeographicalCode: string
Maximum Length:
11
Geographic code used to apply proper taxation rules to the physical address location.
Nested Schema : autopayRequest
Type:
Show Source
object
-
autopayRequestId: string
Maximum Length:
12
A/P Request ID
Nested Schema : paymentCurrency
Type:
Show Source
object
-
paymentCurrency: string
Maximum Length:
3
Currency Code
Nested Schema : items
Type:
Show Source
object
-
_data: array
_data
-
effectiveDate: string
(date)
Effective Date
-
rateSchedule: string
Maximum Length:
8
Rate Schedule
Nested Schema : items
Type:
Show Source
object
-
auditCalculatedAmount: number
Minimum Value:
-1.0E13
Maximum Value:1.0E13
Calculated Amount is the calculated amount associated with the calculation line.Example:1.23000
-
baseAmount: number
Base Amount
-
billableServiceQuantity: number
Minimum Value:
-1.0E12
Maximum Value:1.0E12
Billable Service Quantity is the service quantity priced on the calculation line. This quantity differs from the measured consumption if there are pre-processing calculation groups in effect.Example:1.230000
-
characteristicType: object
characteristicType
-
characteristicValue: string
Maximum Length:
16
Characteristic Value Indicates the value of the characteristic. -
currency: object
currency
-
description: string
Maximum Length:
100
Description describes the characteristic value that was used when the line's amount was calculated. This information is only displayed if the line was calculated using a bill factor (because only bill factors use characteristic values). -
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
-
distributionCode: object
distributionCode
-
exemptAmount: number
Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.Example:
0.00
-
measuresPeakQuantity: boolean
Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.Example:
false
-
rateCompSequence: number
Minimum Value:
-9999
Maximum Value:9999
Sequence -
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence is the system-assigned unique identifier of the calculation detail row.Example:1
-
serviceQuantityIdentifier: object
serviceQuantityIdentifier
-
shouldAppearInSummary: boolean
The Appears in Summary switch defines if this line's amount also appears 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
The Print switch controls whether information about this line will print on the customer's bill.Example:
true
-
timeOfUse: object
timeOfUse
-
unitOfMeasure: object
unitOfMeasure
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : distributionCode
Type:
Show Source
object
-
distributionCode: string
Maximum Length:
10
Distribution Code
Nested Schema : serviceQuantityIdentifier
Type:
Show Source
object
-
serviceQuantityIdentifier: string
Maximum Length:
30
SQI
Nested Schema : unitOfMeasure
Type:
Show Source
object
-
unitOfMeasure: string
Maximum Length:
30
Unit of Measure
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
typeOfCharacteristicValue: string
Maximum Length:
4
Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference. -
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:2
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
accountingDate: string
(date)
Accounting Date
-
arrearsDate: string
(date)
Arrears Date
-
billId: string
Maximum Length:
12
Bill ID -
currentAmount: number
Current Amount
-
financialTransaction: object
financialTransaction
-
payoffAmount: number
Payoff Amount
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : financialTransaction
Type:
Show Source
object
-
financialTransactionId: string
Maximum Length:
12
Financial Transaction ID
Nested Schema : items
Type:
Show Source
object
-
_link: string
(_link)
-
actionName: string
(actionName)
Nested Schema : items
Type:
Show Source
object
-
adjAmt2: number
Transfer Adjustment AmountExample:
0.00
-
adjStatusFlg2: string
Maximum Length:
10
Adjustment Status shows the status of the transfer to adjustment. -
comments2: string
Maximum Length:
100
Use the Comments to describe anything unusual about the adjustment. -
creDt2: string
(date)
Creation Date defines the date on which the adjustment was created.
-
transferAccount: object
transferAccount
-
transferAdjustmentId: string
Maximum Length:
12
Transfer Adjustment ID is the system-assigned, unique identifier of the adjustment. -
transferAdjustmentType: object
transferAdjustmentType
-
transferCurrency: object
transferCurrency
-
transferFinancialTransactions: object
transferFinancialTransactions
-
transferPremise: object
transferPremise
-
transferServiceAgreement: object
transferServiceAgreement
-
version: number
Minimum Value:
0
Maximum Value:0
Version2
Nested Schema : transferAccount
Type:
Show Source
object
-
transferAccountId: string
Maximum Length:
30
Account ID 2
Nested Schema : transferAdjustmentType
Type:
Show Source
object
-
transferAdjustmentType: string
Maximum Length:
8
Transfer Adjustment Type
Nested Schema : transferCurrency
Type:
Show Source
object
-
transferCurrency: string
Maximum Length:
30
Currency Code 2
Nested Schema : transferPremise
Type:
Show Source
object
-
transferPremiseId: string
Maximum Length:
10
Transfer Premise ID
Nested Schema : transferServiceAgreement
Type:
Show Source
object
-
transferServiceAgreementId: string
Maximum Length:
30
Service Agreement ID 2
Nested Schema : items
Type:
Show Source
object
-
arrearsDate: string
(date)
Arrears Date
-
bill: object
bill
-
currentAmount: number
Current Amount
-
financialTransaction: object
financialTransaction
-
payoffAmount: number
Payoff Amount
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : financialTransaction
Type:
Show Source
object
-
financialTransactionId: string
Maximum Length:
12
Financial Transaction ID
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1-Adjust
Type:
Show Source
object
-
_self: string
_self
-
account: object
account
-
accountingDate: string
(date)
Accounting Date
-
accountsPayableRequests: object
accountsPayableRequests
-
adjustmentId: string
Maximum Length:
12
Adjustment ID is the system-assigned, unique identifier of the adjustment. -
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
-
adjustmentType: object
adjustmentType
Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.
-
amount: number
Current Amount
-
approvalRequest: object
approvalRequest
-
baseAmount: number
Current Amount
-
calculatedAmount: number
Calculated Amount is the calculated amount associated with the calculation line.
-
calculationDate: string
(date)
Calculation date is used for a calculated adjustment type by the generate adjustment algorithm for any calculations that are effective dated (e.g., rate version calculation group or bill factor value).Example:
2005-11-23
-
calculationDetails: object
calculationDetails
-
cancel: boolean
(isCancel)
-
cancelReason: object
cancelReason
If the status is canceled, the Cancel Reason is displayed.
-
characteristics: object
characteristics
-
comments: string
Maximum Length:
254
Use the Comments to describe anything unusual about the adjustment. -
creationDate: string
(date)
The Creation Date defines the date on which the adjustment was created.
-
currency: object
currency
-
delete: boolean
(canDelete)
-
financialTransactions: object
financialTransactions
-
freeze: boolean
(isFrozen)
-
generate: boolean
(canGenerate)
-
nextActions: object
nextActions
-
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.
-
submitForApproval: boolean
(isSubmit)
-
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 : 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
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
If the status is canceled, the Cancel Reason is displayed.
Show Source
-
_link: string
_link
-
cancelReason: string
Maximum Length:
4
If the status is canceled, the Cancel Reason is displayed.
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
-
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
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
Nested Schema : items
Type:
Show Source
object
-
account: object
account
-
address1: string
Maximum Length:
254
The first line of the address.Example:1 Speedwell
-
address2: string
Maximum Length:
254
The second line of the address.Example:Morristown
-
address3: string
Maximum Length:
254
The third line of the address. -
address4: string
Maximum Length:
254
The fourth line of the address. -
autopayRequest: object
autopayRequest
-
city: string
Maximum Length:
90
The city of the address.Example:San Francisco
-
country: object
country
-
county: string
Maximum Length:
90
The county of the address.Example:San Francisco
-
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house if applicable for the address. * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
isInCityLimit: boolean
In City Limit switch is on if the address is considered within the physical city limits.Example:
false
-
paidAmount: number
Paid Amount is the amount of the check. This field is only populated after A/P cuts the check.Example:
0.00
-
paymentCurrency: object
paymentCurrency
-
paymentDate: string
(date)
Payment Date is the date on which the check was cut in A/P. This field is only populated after A/P cuts the check.Example:
2005-11-23
-
paymentNumber: string
Maximum Length:
36
Payment Number is the system-assigned number of the payment in A/P (this number typically appears on the printed check). This field is only populated after A/P 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
-
postal: string
Maximum Length:
12
The postal code of the address.Example:07960
-
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 A/P request type.Example:
2005-11-23
-
state: string
Maximum Length:
6
The state of the address.Example:CA
-
streetNumber1: string
Maximum Length:
6
The first street number line of the address. -
streetNumber2: string
Maximum Length:
4
The second street number line of the address. -
taxVendorGeographicalCode: string
Maximum Length:
11
Geographic code used to apply proper taxation rules to the physical address location.
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID
Nested Schema : autopayRequest
Type:
Show Source
object
-
_link: string
_link
-
autopayRequestId: string
Maximum Length:
12
A/P Request ID
Nested Schema : country
Type:
Show Source
object
-
_link: string
_link
-
country: string
Maximum Length:
3
Country
Nested Schema : paymentCurrency
Type:
Show Source
object
-
_link: string
_link
-
paymentCurrency: string
Maximum Length:
3
Currency Code
Nested Schema : items
Type:
Show Source
object
-
_data: array
_data
-
effectiveDate: string
(date)
Effective Date
-
rateSchedule: string
Maximum Length:
8
Rate Schedule
Nested Schema : items
Type:
Show Source
object
-
auditCalculatedAmount: number
Minimum Value:
-1.0E13
Maximum Value:1.0E13
Calculated Amount is the calculated amount associated with the calculation line.Example:1.23000
-
baseAmount: number
Base Amount
-
billableServiceQuantity: number
Minimum Value:
-1.0E12
Maximum Value:1.0E12
Billable Service Quantity is the service quantity priced on the calculation line. This quantity differs from the measured consumption if there are pre-processing calculation groups in effect.Example:1.230000
-
characteristicType: object
characteristicType
-
characteristicValue: string
Maximum Length:
16
Characteristic Value Indicates the value of the characteristic. -
currency: object
currency
-
description: string
Maximum Length:
100
Description describes the characteristic value that was used when the line's amount was calculated. This information is only displayed if the line was calculated using a bill factor (because only bill factors use characteristic values). -
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
-
distributionCode: object
distributionCode
-
exemptAmount: number
Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.Example:
0.00
-
measuresPeakQuantity: boolean
Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.Example:
false
-
rateCompSequence: number
Minimum Value:
-9999
Maximum Value:9999
Sequence -
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence is the system-assigned unique identifier of the calculation detail row.Example:1
-
serviceQuantityIdentifier: object
serviceQuantityIdentifier
-
shouldAppearInSummary: boolean
The Appears in Summary switch defines if this line's amount also appears 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
The Print switch controls whether information about this line will print on the customer's bill.Example:
true
-
timeOfUse: object
timeOfUse
-
unitOfMeasure: object
unitOfMeasure
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristicType
Type:
Show Source
object
-
_link: string
_link
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : currency
Type:
Show Source
object
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : distributionCode
Type:
Show Source
object
-
_link: string
_link
-
distributionCode: string
Maximum Length:
10
Distribution Code
Nested Schema : serviceQuantityIdentifier
Type:
Show Source
object
-
_link: string
_link
-
serviceQuantityIdentifier: string
Maximum Length:
30
SQI
Nested Schema : timeOfUse
Type:
Show Source
object
-
_link: string
_link
-
timeOfUse: string
Maximum Length:
30
Time of Use
Nested Schema : unitOfMeasure
Type:
Show Source
object
-
_link: string
_link
-
unitOfMeasure: string
Maximum Length:
30
Unit of Measure
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
typeOfCharacteristicValue: string
Maximum Length:
4
Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference. -
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:2
Nested Schema : characteristicType
Type:
Show Source
object
-
_link: string
_link
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
accountingDate: string
(date)
Accounting Date
-
arrearsDate: string
(date)
Arrears Date
-
billId: string
Maximum Length:
12
Bill ID -
currentAmount: number
Current Amount
-
financialTransaction: object
financialTransaction
-
payoffAmount: number
Payoff Amount
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : financialTransaction
Type:
Show Source
object
-
_link: string
_link
-
financialTransactionId: string
Maximum Length:
12
Financial Transaction ID
Nested Schema : items
Type:
Show Source
object
-
_link: string
(_link)
-
actionName: string
(actionName)
Nested Schema : items
Type:
Show Source
object
-
adjAmt2: number
Transfer Adjustment AmountExample:
0.00
-
adjStatusFlg2: string
Maximum Length:
10
Adjustment Status shows the status of the transfer to adjustment. -
comments2: string
Maximum Length:
100
Use the Comments to describe anything unusual about the adjustment. -
creDt2: string
(date)
Creation Date defines the date on which the adjustment was created.
-
transferAccount: object
transferAccount
-
transferAdjustmentId: string
Maximum Length:
12
Transfer Adjustment ID is the system-assigned, unique identifier of the adjustment. -
transferAdjustmentType: object
transferAdjustmentType
-
transferCurrency: object
transferCurrency
-
transferFinancialTransactions: object
transferFinancialTransactions
-
transferPremise: object
transferPremise
-
transferServiceAgreement: object
transferServiceAgreement
-
version: number
Minimum Value:
0
Maximum Value:0
Version2
Nested Schema : transferAccount
Type:
Show Source
object
-
_link: string
_link
-
transferAccountId: string
Maximum Length:
30
Account ID 2
Nested Schema : transferAdjustmentType
Type:
Show Source
object
-
_link: string
_link
-
transferAdjustmentType: string
Maximum Length:
8
Transfer Adjustment Type
Nested Schema : transferCurrency
Type:
Show Source
object
-
_link: string
_link
-
transferCurrency: string
Maximum Length:
30
Currency Code 2
Nested Schema : transferPremise
Type:
Show Source
object
-
_link: string
_link
-
transferPremiseId: string
Maximum Length:
10
Transfer Premise ID
Nested Schema : transferServiceAgreement
Type:
Show Source
object
-
_link: string
_link
-
transferServiceAgreementId: string
Maximum Length:
30
Service Agreement ID 2
Nested Schema : items
Type:
Show Source
object
-
arrearsDate: string
(date)
Arrears Date
-
bill: object
bill
-
currentAmount: number
Current Amount
-
financialTransaction: object
financialTransaction
-
payoffAmount: number
Payoff Amount
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
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
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.