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

Create Adjustment

post

/rest/apis/customer/financials/adjustments/

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : accountsPayableRequests
Type: object
Show Source
  • Maximum Length: 10
    Account ID is the account to which the adjustment is linked.
    Example: 1589800000
  • Maximum Length: 254
    The first line of the address.
    Example: 1 Speedwell
  • Maximum Length: 254
    The second line of the address.
    Example: Morristown
  • Maximum Length: 254
    The third line of the address.
  • Maximum Length: 254
    The fourth line of the address.
  • Advice Date
  • Maximum Length: 20
    Advice ID
  • Maximum Length: 12
    Accounts Payable Request ID is the system-assigned, unique identifier of the accounts payable check request.
    Example: 043888888800
  • Maximum Length: 8
    Batch Control
  • Minimum Value: -9999999999
    Maximum Value: 9999999999
    Batch Number
  • Maximum Length: 90
    The city of the address.
    Example: San Francisco
  • Maximum Length: 3
    Country defaults from the installation options. The address constituents may differ depending on the Country.
  • Maximum Length: 90
    The county of the address.
    Example: San Francisco
  • Maximum Length: 254
    Name
  • House Type indicates the type of house if applicable for the address.
  • In City Limit switch is on if the address is considered within the physical city limits.
    Example: false
  • Paid Amount is the amount of the check. This field is only populated after accounts payable cuts the check.
    Example: 0.00
  • Maximum Length: 3
    Currency Code defines the currency in which the account's financial transactions are expressed.
    Example: USD
  • Payment Date is the date on which the check was cut by accounts payable. This field is only populated after accounts payable cuts the check.
    Example: 2005-11-23
  • Maximum Length: 36
    Payment Number is the system-assigned number of the payment in accounts payable, and this number typically appears on the printed check. This field is only populated after accounts payable cuts the check.
  • Allowed Values: [ "C ", "D ", "H ", "N ", "P ", "R ", "V ", "X " ]
    Payment Selection Status is the status of the check request. * `C ` - Closed, * `D ` - Negative Voucher Sum, * `H ` - Held, * `N ` - Not Selected for Payment, * `P ` - Paid, * `R ` - Requested for Payment, * `V ` - Convert Error, * `X ` - Canceled
    Example: N
  • Maximum Length: 12
    The postal code of the address.
    Example: 07960
  • 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
  • Maximum Length: 6
    The state of the address.
    Example: CA
  • Maximum Length: 6
    The first street number line of the address.
  • Maximum Length: 4
    The second street number line of the address.
  • Maximum Length: 11
    Geographic code used to apply proper taxation rules to the physical address location.
Nested Schema : adjRv
Type: array
Show Source
Nested Schema : characteristics
Type: array
Show Source
Nested Schema : nextActions
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : adjCalcLine
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Minimum Value: -10000000000000
    Maximum Value: 10000000000000
    Calculated Amount is the calculated amount associated with the calculation line.
    Example: 1.23000
  • 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
  • Minimum Value: -1000000000000
    Maximum Value: 1000000000000
    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
  • Maximum Length: 30
    Calculation Group
  • Maximum Length: 30
    Calculation Rule
  • Maximum Length: 8
    Characteristic Type Indicates the type of characteristic.
  • Maximum Length: 16
    Characteristic Value Indicates the value of the characteristic.
  • Maximum Length: 3
    Currency Code
  • 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.
  • Maximum Length: 254
    Description on Bill is the information about the calculation line that appears on the customer's bill.
    Example: Base Adjustment Amount
  • Maximum Length: 10
    Distribution Code is the distribution code associated with the calculation line. This distribution code is used to build the general ledger details on the bill segment's financial transaction.
    Example: E - MISC
  • 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
  • Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.
    Example: false
  • Minimum Value: -9999
    Maximum Value: 9999
    Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line.
    Example: 10
  • Minimum Value: -99999
    Maximum Value: 99999
    Sequence is the system-assigned unique identifier of the calculation detail row.
    Example: 1
  • Maximum Length: 30
    SQI is the service quantity identifier of the service quantity priced on the calculation line.
    Example: BASEADJ
  • Define Appears in Summary as true to display this line's amount on a summary line. This switch plays a part at bill print time - those lines that appear in a summary print in the left dollar column, those that don't appear in a summary print in the right dollar column.
    Example: true
  • Define Print as true to print this line on the customer's bill.
    Example: true
  • Maximum Length: 30
    Time of Use (TOU) is the time-of-use code of the service quantity priced on the calculation line.
  • Maximum Length: 30
    Unit of Measure (UOM) is the unit of measure of the service quantity priced on the calculation line.
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 8
    Characteristic Type Indicates the type of characteristic.
  • characteristicValue
  • Minimum Value: -999
    Maximum Value: 999
    Sequence controls the order in which characteristics of the same type are displayed.
    Example: 1
  • Allowed Values: [ "ADV ", "DFV ", "FKV ", "FLV " ]
    Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference. * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 2
Nested Schema : characteristicValue
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "C1CN", "C1DE", "C1FR", "C1GN", "C1SA" ]
    Available actions for the Adjustment * `C1CN` - Cancel, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1SA` - Submit For Approval
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : accountsPayableRequests
Type: object
Show Source
  • Maximum Length: 10
    Account ID is the account to which the adjustment is linked.
    Example: 1589800000
  • Maximum Length: 254
    The first line of the address.
    Example: 1 Speedwell
  • Maximum Length: 254
    The second line of the address.
    Example: Morristown
  • Maximum Length: 254
    The third line of the address.
  • Maximum Length: 254
    The fourth line of the address.
  • Advice Date
  • Maximum Length: 20
    Advice ID
  • Maximum Length: 12
    Accounts Payable Request ID is the system-assigned, unique identifier of the accounts payable check request.
    Example: 043888888800
  • Maximum Length: 8
    Batch Control
  • Minimum Value: -9999999999
    Maximum Value: 9999999999
    Batch Number
  • Maximum Length: 90
    The city of the address.
    Example: San Francisco
  • Maximum Length: 3
    Country defaults from the installation options. The address constituents may differ depending on the Country.
  • Maximum Length: 90
    The county of the address.
    Example: San Francisco
  • Maximum Length: 254
    Name
  • House Type indicates the type of house if applicable for the address.
  • In City Limit switch is on if the address is considered within the physical city limits.
    Example: false
  • Paid Amount is the amount of the check. This field is only populated after accounts payable cuts the check.
    Example: 0.00
  • Maximum Length: 3
    Currency Code defines the currency in which the account's financial transactions are expressed.
    Example: USD
  • Payment Date is the date on which the check was cut by accounts payable. This field is only populated after accounts payable cuts the check.
    Example: 2005-11-23
  • Maximum Length: 36
    Payment Number is the system-assigned number of the payment in accounts payable, and this number typically appears on the printed check. This field is only populated after accounts payable cuts the check.
  • Allowed Values: [ "C ", "D ", "H ", "N ", "P ", "R ", "V ", "X " ]
    Payment Selection Status is the status of the check request. * `C ` - Closed, * `D ` - Negative Voucher Sum, * `H ` - Held, * `N ` - Not Selected for Payment, * `P ` - Paid, * `R ` - Requested for Payment, * `V ` - Convert Error, * `X ` - Canceled
    Example: N
  • Maximum Length: 12
    The postal code of the address.
    Example: 07960
  • 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
  • Maximum Length: 6
    The state of the address.
    Example: CA
  • Maximum Length: 6
    The first street number line of the address.
  • Maximum Length: 4
    The second street number line of the address.
  • Maximum Length: 11
    Geographic code used to apply proper taxation rules to the physical address location.
Nested Schema : adjRv
Type: array
Show Source
Nested Schema : characteristics
Type: array
Show Source
Nested Schema : nextActions
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : adjCalcLine
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Minimum Value: -10000000000000
    Maximum Value: 10000000000000
    Calculated Amount is the calculated amount associated with the calculation line.
    Example: 1.23000
  • 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
  • Minimum Value: -1000000000000
    Maximum Value: 1000000000000
    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
  • Maximum Length: 30
    Calculation Group
  • Maximum Length: 30
    Calculation Rule
  • Maximum Length: 8
    Characteristic Type Indicates the type of characteristic.
  • Maximum Length: 16
    Characteristic Value Indicates the value of the characteristic.
  • Maximum Length: 3
    Currency Code
  • 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.
  • Maximum Length: 254
    Description on Bill is the information about the calculation line that appears on the customer's bill.
    Example: Base Adjustment Amount
  • Maximum Length: 10
    Distribution Code is the distribution code associated with the calculation line. This distribution code is used to build the general ledger details on the bill segment's financial transaction.
    Example: E - MISC
  • 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
  • Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.
    Example: false
  • Minimum Value: -9999
    Maximum Value: 9999
    Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line.
    Example: 10
  • Minimum Value: -99999
    Maximum Value: 99999
    Sequence is the system-assigned unique identifier of the calculation detail row.
    Example: 1
  • Maximum Length: 30
    SQI is the service quantity identifier of the service quantity priced on the calculation line.
    Example: BASEADJ
  • Define Appears in Summary as true to display this line's amount on a summary line. This switch plays a part at bill print time - those lines that appear in a summary print in the left dollar column, those that don't appear in a summary print in the right dollar column.
    Example: true
  • Define Print as true to print this line on the customer's bill.
    Example: true
  • Maximum Length: 30
    Time of Use (TOU) is the time-of-use code of the service quantity priced on the calculation line.
  • Maximum Length: 30
    Unit of Measure (UOM) is the unit of measure of the service quantity priced on the calculation line.
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 8
    Characteristic Type Indicates the type of characteristic.
  • characteristicValue
  • Minimum Value: -999
    Maximum Value: 999
    Sequence controls the order in which characteristics of the same type are displayed.
    Example: 1
  • Allowed Values: [ "ADV ", "DFV ", "FKV ", "FLV " ]
    Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference. * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 2
Nested Schema : characteristicValue
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "C1CN", "C1DE", "C1FR", "C1GN", "C1SA" ]
    Available actions for the Adjustment * `C1CN` - Cancel, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1SA` - Submit For Approval
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : C1Adjustment
Type: object
Show Source
Nested Schema : accountsPayableRequests
Type: object
Show Source
  • Maximum Length: 10
    Account ID is the account to which the adjustment is linked.
    Example: 1589800000
  • Maximum Length: 254
    The first line of the address.
    Example: 1 Speedwell
  • Maximum Length: 254
    The second line of the address.
    Example: Morristown
  • Maximum Length: 254
    The third line of the address.
  • Maximum Length: 254
    The fourth line of the address.
  • Advice Date
  • Maximum Length: 20
    Advice ID
  • Maximum Length: 12
    Accounts Payable Request ID is the system-assigned, unique identifier of the accounts payable check request.
    Example: 043888888800
  • Maximum Length: 8
    Batch Control
  • Minimum Value: -9999999999
    Maximum Value: 9999999999
    Batch Number
  • Maximum Length: 90
    The city of the address.
    Example: San Francisco
  • Maximum Length: 3
    Country defaults from the installation options. The address constituents may differ depending on the Country.
  • Maximum Length: 90
    The county of the address.
    Example: San Francisco
  • Maximum Length: 254
    Name
  • House Type indicates the type of house if applicable for the address.
  • In City Limit switch is on if the address is considered within the physical city limits.
    Example: false
  • Paid Amount is the amount of the check. This field is only populated after accounts payable cuts the check.
    Example: 0.00
  • Maximum Length: 3
    Currency Code defines the currency in which the account's financial transactions are expressed.
    Example: USD
  • Payment Date is the date on which the check was cut by accounts payable. This field is only populated after accounts payable cuts the check.
    Example: 2005-11-23
  • Maximum Length: 36
    Payment Number is the system-assigned number of the payment in accounts payable, and this number typically appears on the printed check. This field is only populated after accounts payable cuts the check.
  • Allowed Values: [ "C ", "D ", "H ", "N ", "P ", "R ", "V ", "X " ]
    Payment Selection Status is the status of the check request. * `C ` - Closed, * `D ` - Negative Voucher Sum, * `H ` - Held, * `N ` - Not Selected for Payment, * `P ` - Paid, * `R ` - Requested for Payment, * `V ` - Convert Error, * `X ` - Canceled
    Example: N
  • Maximum Length: 12
    The postal code of the address.
    Example: 07960
  • 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
  • Maximum Length: 6
    The state of the address.
    Example: CA
  • Maximum Length: 6
    The first street number line of the address.
  • Maximum Length: 4
    The second street number line of the address.
  • Maximum Length: 11
    Geographic code used to apply proper taxation rules to the physical address location.
Nested Schema : adjRv
Type: array
Show Source
Nested Schema : characteristics
Type: array
Show Source
Nested Schema : nextActions
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : adjCalcLine
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Minimum Value: -10000000000000
    Maximum Value: 10000000000000
    Calculated Amount is the calculated amount associated with the calculation line.
    Example: 1.23000
  • 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
  • Minimum Value: -1000000000000
    Maximum Value: 1000000000000
    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
  • Maximum Length: 30
    Calculation Group
  • Maximum Length: 30
    Calculation Rule
  • Maximum Length: 8
    Characteristic Type Indicates the type of characteristic.
  • Maximum Length: 16
    Characteristic Value Indicates the value of the characteristic.
  • Maximum Length: 3
    Currency Code
  • 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.
  • Maximum Length: 254
    Description on Bill is the information about the calculation line that appears on the customer's bill.
    Example: Base Adjustment Amount
  • Maximum Length: 10
    Distribution Code is the distribution code associated with the calculation line. This distribution code is used to build the general ledger details on the bill segment's financial transaction.
    Example: E - MISC
  • 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
  • Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.
    Example: false
  • Minimum Value: -9999
    Maximum Value: 9999
    Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line.
    Example: 10
  • Minimum Value: -99999
    Maximum Value: 99999
    Sequence is the system-assigned unique identifier of the calculation detail row.
    Example: 1
  • Maximum Length: 30
    SQI is the service quantity identifier of the service quantity priced on the calculation line.
    Example: BASEADJ
  • Define Appears in Summary as true to display this line's amount on a summary line. This switch plays a part at bill print time - those lines that appear in a summary print in the left dollar column, those that don't appear in a summary print in the right dollar column.
    Example: true
  • Define Print as true to print this line on the customer's bill.
    Example: true
  • Maximum Length: 30
    Time of Use (TOU) is the time-of-use code of the service quantity priced on the calculation line.
  • Maximum Length: 30
    Unit of Measure (UOM) is the unit of measure of the service quantity priced on the calculation line.
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 8
    Characteristic Type Indicates the type of characteristic.
  • characteristicValue
  • Minimum Value: -999
    Maximum Value: 999
    Sequence controls the order in which characteristics of the same type are displayed.
    Example: 1
  • Allowed Values: [ "ADV ", "DFV ", "FKV ", "FLV " ]
    Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference. * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value
  • Minimum Value: -99999
    Maximum Value: 99999
    The Version number is used for internal concurrency checks.
    Example: 2
Nested Schema : characteristicValue
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • 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
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • Maximum Length: 60
    Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
  • Maximum Length: 60
    URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
  • serverMessage
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

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