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
-
adjustmentDataArea: string
Maximum Length:
9999
Adjustment Data Area -
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
Base Amount is used by calculation lines, such as taxes, that are cross-referenced to other calculation lines on which their values depend on. The Base Amount shows the total amount derived from the cross-referenced lines that the current line then used to calculate its billed amount.Example:
0.00
-
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.
-
characteristics: object
characteristics
-
comments: string
Maximum Length:
254
Use the Comments to describe anything unique about the adjustment. -
createDate: string
(date)
The Creation Date defines the date on which the adjustment was created.
-
currency: object
currency
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:GET
-
ilmDate: string
(date)
ILM Date
-
isEligibleForArchiving: boolean
ILM Archive Switch
-
nextActions: array
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.
-
transferAdjustmentId: string
Maximum Length:
12
Transfer Adjustment ID is the system-assigned, unique identifier of the adjustment. -
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 : accountsPayableRequests
Type:
Show Source
object
-
account: object
account
-
accountsPayableRequest: object
accountsPayableRequest
-
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. -
adviceDate: string
(date)
Advice Date
-
adviceId: string
Maximum Length:
20
Advice ID -
batchControl: string
Maximum Length:
8
Batch Control -
batchNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Number -
city: string
Maximum Length:
90
The city of the address.Example:San Francisco
-
country: object
country
Country defaults from the installation options. The address constituents may differ depending on the Country.
-
county: string
Maximum Length:
90
The county of the address.Example:San Francisco
-
entityName: string
Maximum Length:
254
Name -
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 accounts payable cuts the check.Example:
0.00
-
paymentCurrency: object
paymentCurrency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
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
-
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 accounts payable 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 : 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
The Cancel Reason describes the reason for the cancelation.
Show Source
-
cancelReason: string
Maximum Length:
4
The Cancel Reason describes the reason for the cancelation.
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
-
serviceAgreement: string
Maximum Length:
10
Service Agreement
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 : accountsPayableRequest
Type:
Show Source
object
-
autopayRequestId: string
Maximum Length:
12
A/P Request ID
Nested Schema : country
Type:
object
Country defaults from the installation options. The address constituents may differ depending on the Country.
Show Source
-
country: string
Maximum Length:
3
Country defaults from the installation options. The address constituents may differ depending on the Country.
Nested Schema : paymentCurrency
Type:
object
Currency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
paymentCurrency: string
Maximum Length:
3
Currency Code defines the currency in which the account's financial transactions are expressed.Example:USD
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
-
calculationGroup: string
Maximum Length:
30
Calculation Group -
calculationRule: string
Maximum Length:
30
Calculation Rule -
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. -
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
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
-
timeOfUse: object
timeOfUse
-
unitOfMeasure: object
unitOfMeasure
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 controls the order in which characteristics of the same type are displayed.Example:1
-
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
-
action: string
Allowed Values:
[ "C1CN", "C1DE", "C1FR", "C1GN", "C1SA" ]
Available actions for the Adjustment * `C1CN` - Cancel, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1SA` - Submit For Approval
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
accountingDate: string
(date)
Accounting Date
-
accountsPayableRequests: object
accountsPayableRequests
-
adjustmentDataArea: string
Maximum Length:
9999
Adjustment Data Area -
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
Base Amount is used by calculation lines, such as taxes, that are cross-referenced to other calculation lines on which their values depend on. The Base Amount shows the total amount derived from the cross-referenced lines that the current line then used to calculate its billed amount.Example:
0.00
-
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.
-
characteristics: object
characteristics
-
comments: string
Maximum Length:
254
Use the Comments to describe anything unique about the adjustment. -
createDate: string
(date)
The Creation Date defines the date on which the adjustment was created.
-
currency: object
currency
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:GET
-
ilmDate: string
(date)
ILM Date
-
isEligibleForArchiving: boolean
ILM Archive Switch
-
nextActions: array
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.
-
transferAdjustmentId: string
Maximum Length:
12
Transfer Adjustment ID is the system-assigned, unique identifier of the adjustment. -
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 : accountsPayableRequests
Type:
Show Source
object
-
account: object
account
-
accountsPayableRequest: object
accountsPayableRequest
-
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. -
adviceDate: string
(date)
Advice Date
-
adviceId: string
Maximum Length:
20
Advice ID -
batchControl: string
Maximum Length:
8
Batch Control -
batchNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Number -
city: string
Maximum Length:
90
The city of the address.Example:San Francisco
-
country: object
country
Country defaults from the installation options. The address constituents may differ depending on the Country.
-
county: string
Maximum Length:
90
The county of the address.Example:San Francisco
-
entityName: string
Maximum Length:
254
Name -
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 accounts payable cuts the check.Example:
0.00
-
paymentCurrency: object
paymentCurrency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
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
-
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 accounts payable 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 : 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
The Cancel Reason describes the reason for the cancelation.
Show Source
-
cancelReason: string
Maximum Length:
4
The Cancel Reason describes the reason for the cancelation.
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
-
serviceAgreement: string
Maximum Length:
10
Service Agreement
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 : accountsPayableRequest
Type:
Show Source
object
-
autopayRequestId: string
Maximum Length:
12
A/P Request ID
Nested Schema : country
Type:
object
Country defaults from the installation options. The address constituents may differ depending on the Country.
Show Source
-
country: string
Maximum Length:
3
Country defaults from the installation options. The address constituents may differ depending on the Country.
Nested Schema : paymentCurrency
Type:
object
Currency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
paymentCurrency: string
Maximum Length:
3
Currency Code defines the currency in which the account's financial transactions are expressed.Example:USD
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
-
calculationGroup: string
Maximum Length:
30
Calculation Group -
calculationRule: string
Maximum Length:
30
Calculation Rule -
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. -
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
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
-
timeOfUse: object
timeOfUse
-
unitOfMeasure: object
unitOfMeasure
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 controls the order in which characteristics of the same type are displayed.Example:1
-
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
-
action: string
Allowed Values:
[ "C1CN", "C1DE", "C1FR", "C1GN", "C1SA" ]
Available actions for the Adjustment * `C1CN` - Cancel, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1SA` - Submit For Approval
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1Adjustment
Type:
Show Source
object
-
_self: string
_self
-
account: object
account
-
accountingDate: string
(date)
Accounting Date
-
accountsPayableRequests: object
accountsPayableRequests
-
adjustmentDataArea: string
Maximum Length:
9999
Adjustment Data Area -
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
Base Amount is used by calculation lines, such as taxes, that are cross-referenced to other calculation lines on which their values depend on. The Base Amount shows the total amount derived from the cross-referenced lines that the current line then used to calculate its billed amount.Example:
0.00
-
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.
-
characteristics: object
characteristics
-
comments: string
Maximum Length:
254
Use the Comments to describe anything unique about the adjustment. -
createDate: string
(date)
The Creation Date defines the date on which the adjustment was created.
-
currency: object
currency
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:GET
-
ilmDate: string
(date)
ILM Date
-
isEligibleForArchiving: boolean
ILM Archive Switch
-
nextActions: array
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.
-
transferAdjustmentId: string
Maximum Length:
12
Transfer Adjustment ID is the system-assigned, unique identifier of the adjustment. -
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
-
account: object
account
-
accountsPayableRequest: object
accountsPayableRequest
-
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. -
adviceDate: string
(date)
Advice Date
-
adviceId: string
Maximum Length:
20
Advice ID -
batchControl: string
Maximum Length:
8
Batch Control -
batchNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Number -
city: string
Maximum Length:
90
The city of the address.Example:San Francisco
-
country: object
country
Country defaults from the installation options. The address constituents may differ depending on the Country.
-
county: string
Maximum Length:
90
The county of the address.Example:San Francisco
-
entityName: string
Maximum Length:
254
Name -
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 accounts payable cuts the check.Example:
0.00
-
paymentCurrency: object
paymentCurrency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
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
-
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 accounts payable 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 : 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
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.
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
-
serviceAgreement: string
Maximum Length:
10
Service Agreement
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 : accountsPayableRequest
Type:
Show Source
object
-
_link: string
_link
-
autopayRequestId: string
Maximum Length:
12
A/P Request ID
Nested Schema : country
Type:
object
Country defaults from the installation options. The address constituents may differ depending on the Country.
Show Source
-
_link: string
_link
-
country: string
Maximum Length:
3
Country defaults from the installation options. The address constituents may differ depending on the Country.
Nested Schema : paymentCurrency
Type:
object
Currency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
_link: string
_link
-
paymentCurrency: string
Maximum Length:
3
Currency Code defines the currency in which the account's financial transactions are expressed.Example:USD
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
-
calculationGroup: string
Maximum Length:
30
Calculation Group -
calculationRule: string
Maximum Length:
30
Calculation Rule -
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. -
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
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
-
timeOfUse: object
timeOfUse
-
unitOfMeasure: object
unitOfMeasure
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
-
currency3: 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 controls the order in which characteristics of the same type are displayed.Example:1
-
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
-
action: string
Allowed Values:
[ "C1CN", "C1DE", "C1FR", "C1GN", "C1SA" ]
Available actions for the Adjustment * `C1CN` - Cancel, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1SA` - Submit For Approval
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.