Jump to

• Request
• Response

Get Adjustment

get

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

Request

Path Parameters

• adjustmentId(required): string
  Adjustment ID is the system-assigned, unique identifier of the adjustment.

  Example:

  011163134133

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1Adjustment

Type: object

Show Source

• _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 ` - Canceled

  Example: 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 ` - Put

  Example: 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

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put",
            "example":"GET"
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID is the account to which the adjustment is linked.",
                    "example":"1589800000"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
                    "example":"4000000099"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "onBehalfSAId":{
            "type":"string",
            "maxLength":10,
            "description":"On Behalf SA ID is only populated on system-generated adjustments instigated by one customer, but attributed to another customer."
        },
        "adjustmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Adjustment ID is the system-assigned, unique identifier of the adjustment."
        },
        "serviceAgreement":{
            "type":"object",
            "description":"Service Agreement ID whose financial balance needs to be adjusted.",
            "properties":{
                "serviceAgreement":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "adjustmentType":{
            "type":"object",
            "description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.",
            "properties":{
                "adjustmentType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.",
                    "example":"CUSTREL"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "adjustmentStatus":{
            "type":"string",
            "enum":[
                "05  ",
                "10  ",
                "20  ",
                "30  ",
                "50  ",
                "60  "
            ],
            "description":"Adjustment Status shows the status of the transfer to adjustment. If you need to change the adjustment's status, use the action links.\n* `05  ` - New,\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled",
            "example":"30"
        },
        "createDate":{
            "type":"string",
            "format":"date",
            "description":"The Creation Date defines the date on which the adjustment was created."
        },
        "cancelReason":{
            "type":"object",
            "description":"The Cancel Reason describes the reason for the cancelation.",
            "properties":{
                "cancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"The Cancel Reason describes the reason for the cancelation."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "amount":{
            "type":"number",
            "description":"Current Amount"
        },
        "transferAdjustmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Transfer Adjustment ID is the system-assigned, unique identifier of the adjustment."
        },
        "currency":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Use the Comments to describe anything unique about the adjustment."
        },
        "accountingDate":{
            "type":"string",
            "format":"date",
            "description":"Accounting Date"
        },
        "calculationDate":{
            "type":"string",
            "format":"date",
            "description":"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"
        },
        "baseAmount":{
            "type":"number",
            "description":"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"
        },
        "adjustmentDataArea":{
            "type":"string",
            "maxLength":9999,
            "description":"Adjustment Data Area"
        },
        "approvalRequest":{
            "type":"object",
            "properties":{
                "approvalRequestId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"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."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "ilmDate":{
            "type":"string",
            "format":"date",
            "description":"ILM Date"
        },
        "isEligibleForArchiving":{
            "type":"boolean",
            "description":"ILM Archive Switch"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "accountsPayableRequests":{
            "type":"object",
            "properties":{
                "accountsPayableRequest":{
                    "type":"object",
                    "properties":{
                        "autopayRequestId":{
                            "type":"string",
                            "maxLength":12,
                            "description":"A/P Request ID"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "account":{
                    "type":"object",
                    "properties":{
                        "accountId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Account ID is the account to which the adjustment is linked.",
                            "example":"1589800000"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "paymentSelectionStatus":{
                    "type":"string",
                    "enum":[
                        "C   ",
                        "D   ",
                        "H   ",
                        "N   ",
                        "P   ",
                        "R   ",
                        "V   ",
                        "X   "
                    ],
                    "description":"Payment Selection Status is the status of the check request.\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled",
                    "example":"N"
                },
                "paymentNumber":{
                    "type":"string",
                    "maxLength":36,
                    "description":"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."
                },
                "scheduledToPayDate":{
                    "type":"string",
                    "format":"date",
                    "description":"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"
                },
                "paymentDate":{
                    "type":"string",
                    "format":"date",
                    "description":"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"
                },
                "paidAmount":{
                    "type":"number",
                    "description":"Paid Amount is the amount of the check. This field is only populated after accounts payable cuts the check.",
                    "example":"0.00"
                },
                "paymentCurrency":{
                    "type":"object",
                    "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                    "properties":{
                        "paymentCurrency":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                            "example":"USD"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "country":{
                    "type":"object",
                    "description":"Country defaults from the installation options. The address constituents may differ depending on the Country.",
                    "properties":{
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Country defaults from the installation options. The address constituents may differ depending on the Country."
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The postal code of the address.",
                    "example":"07960"
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The first line of the address.",
                    "example":"1 Speedwell"
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The second line of the address.",
                    "example":"Morristown"
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The third line of the address."
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The fourth line of the address."
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The city of the address.",
                    "example":"San Francisco"
                },
                "streetNumber1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The first street number line of the address."
                },
                "streetNumber2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"The second street number line of the address."
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The county of the address.",
                    "example":"San Francisco"
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The state of the address.",
                    "example":"CA"
                },
                "taxVendorGeographicalCode":{
                    "type":"string",
                    "maxLength":11,
                    "description":"Geographic code used to apply proper taxation rules to the physical address location."
                },
                "isInCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit switch is on if the address is considered within the physical city limits.",
                    "example":"false"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type indicates the type of house if applicable for the address.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "batchControl":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Batch Control"
                },
                "batchNumber":{
                    "type":"number",
                    "maximum":9.999999999E9,
                    "minimum":-9.999999999E9,
                    "description":"Batch Number"
                },
                "entityName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Name"
                },
                "adviceId":{
                    "type":"string",
                    "maxLength":20,
                    "description":"Advice ID"
                },
                "adviceDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Advice Date"
                }
            }
        },
        "calculationDetails":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "rateSchedule":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Rate Schedule"
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Sequence is the system-assigned unique identifier of the calculation detail row.",
                                            "example":"1"
                                        },
                                        "descriptionOnBill":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Description on Bill is the information about the calculation line that appears on the customer's bill.",
                                            "example":"Base Adjustment Amount"
                                        },
                                        "auditCalculatedAmount":{
                                            "type":"number",
                                            "maximum":1.0E13,
                                            "minimum":-1.0E13,
                                            "description":"Calculated Amount is the calculated amount associated with the calculation line.",
                                            "example":"1.23000"
                                        },
                                        "shouldPrint":{
                                            "type":"boolean",
                                            "description":"Define Print as true to print this line on the customer's bill.",
                                            "example":"true"
                                        },
                                        "shouldAppearInSummary":{
                                            "type":"boolean",
                                            "description":"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"
                                        },
                                        "unitOfMeasure":{
                                            "type":"object",
                                            "properties":{
                                                "unitOfMeasure":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Unit of Measure"
                                                },
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                }
                                            }
                                        },
                                        "timeOfUse":{
                                            "type":"object",
                                            "properties":{
                                                "timeOfUse":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Time of Use"
                                                },
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                }
                                            }
                                        },
                                        "serviceQuantityIdentifier":{
                                            "type":"object",
                                            "properties":{
                                                "serviceQuantityIdentifier":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"SQI"
                                                },
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                }
                                            }
                                        },
                                        "billableServiceQuantity":{
                                            "type":"number",
                                            "maximum":1.0E12,
                                            "minimum":-1.0E12,
                                            "description":"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"
                                        },
                                        "baseAmount":{
                                            "type":"number",
                                            "description":"Base Amount"
                                        },
                                        "currency":{
                                            "type":"string",
                                            "maxLength":3,
                                            "description":"Currency Code"
                                        },
                                        "rateCompSequence":{
                                            "type":"number",
                                            "maximum":9999,
                                            "minimum":-9999,
                                            "description":"Sequence"
                                        },
                                        "measuresPeakQuantity":{
                                            "type":"boolean",
                                            "description":"Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.",
                                            "example":"false"
                                        },
                                        "exemptAmount":{
                                            "type":"number",
                                            "description":"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"
                                        },
                                        "distributionCode":{
                                            "type":"object",
                                            "properties":{
                                                "distributionCode":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Distribution Code"
                                                },
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                }
                                            }
                                        },
                                        "description":{
                                            "type":"string",
                                            "maxLength":100,
                                            "description":"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."
                                        },
                                        "calculationGroup":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Calculation Group"
                                        },
                                        "calculationRule":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Calculation Rule"
                                        },
                                        "characteristicType":{
                                            "type":"object",
                                            "properties":{
                                                "characteristicType":{
                                                    "type":"string",
                                                    "maxLength":8,
                                                    "description":"Characteristic Type"
                                                },
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                }
                                            }
                                        },
                                        "characteristicValue":{
                                            "type":"string",
                                            "maxLength":16,
                                            "description":"Characteristic Value Indicates the value of the characteristic."
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence controls the order in which characteristics of the same type are displayed.",
                                "example":"1"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference."
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "description":"(value)"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "description":"(value2)"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "description":"(value3)"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "description":"(value4)"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "description":"(value5)"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"2"
                            }
                        }
                    }
                }
            }
        },
        "nextActions":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "action":{
                        "type":"string",
                        "enum":[
                            "C1CN",
                            "C1DE",
                            "C1FR",
                            "C1GN",
                            "C1SA"
                        ],
                        "description":"Available actions for the  Adjustment\n* `C1CN` - Cancel,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1SA` - Submit For Approval"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1Adjustment"
    }
}

Nested Schema : account

Type: object

Show Source

• _link: string
  _link
• accountId: string
  Maximum Length: 10

  Account ID is the account to which the adjustment is linked.

  Example: 1589800000

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID is the account to which the adjustment is linked.",
            "example":"1589800000"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : accountsPayableRequests

Type: object

Show Source

• 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 ` - Canceled

  Example: 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.

{
    "type":"object",
    "properties":{
        "accountsPayableRequest":{
            "type":"object",
            "properties":{
                "autopayRequestId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"A/P Request ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID is the account to which the adjustment is linked.",
                    "example":"1589800000"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "paymentSelectionStatus":{
            "type":"string",
            "enum":[
                "C   ",
                "D   ",
                "H   ",
                "N   ",
                "P   ",
                "R   ",
                "V   ",
                "X   "
            ],
            "description":"Payment Selection Status is the status of the check request.\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled",
            "example":"N"
        },
        "paymentNumber":{
            "type":"string",
            "maxLength":36,
            "description":"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."
        },
        "scheduledToPayDate":{
            "type":"string",
            "format":"date",
            "description":"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"
        },
        "paymentDate":{
            "type":"string",
            "format":"date",
            "description":"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"
        },
        "paidAmount":{
            "type":"number",
            "description":"Paid Amount is the amount of the check. This field is only populated after accounts payable cuts the check.",
            "example":"0.00"
        },
        "paymentCurrency":{
            "type":"object",
            "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
            "properties":{
                "paymentCurrency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                    "example":"USD"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "country":{
            "type":"object",
            "description":"Country defaults from the installation options. The address constituents may differ depending on the Country.",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country defaults from the installation options. The address constituents may differ depending on the Country."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The postal code of the address.",
            "example":"07960"
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"The first line of the address.",
            "example":"1 Speedwell"
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"The second line of the address.",
            "example":"Morristown"
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"The third line of the address."
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"The fourth line of the address."
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The city of the address.",
            "example":"San Francisco"
        },
        "streetNumber1":{
            "type":"string",
            "maxLength":6,
            "description":"The first street number line of the address."
        },
        "streetNumber2":{
            "type":"string",
            "maxLength":4,
            "description":"The second street number line of the address."
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"The county of the address.",
            "example":"San Francisco"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"The state of the address.",
            "example":"CA"
        },
        "taxVendorGeographicalCode":{
            "type":"string",
            "maxLength":11,
            "description":"Geographic code used to apply proper taxation rules to the physical address location."
        },
        "isInCityLimit":{
            "type":"boolean",
            "description":"In City Limit switch is on if the address is considered within the physical city limits.",
            "example":"false"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type indicates the type of house if applicable for the address.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "batchControl":{
            "type":"string",
            "maxLength":8,
            "description":"Batch Control"
        },
        "batchNumber":{
            "type":"number",
            "maximum":9.999999999E9,
            "minimum":-9.999999999E9,
            "description":"Batch Number"
        },
        "entityName":{
            "type":"string",
            "maxLength":254,
            "description":"Name"
        },
        "adviceId":{
            "type":"string",
            "maxLength":20,
            "description":"Advice ID"
        },
        "adviceDate":{
            "type":"string",
            "format":"date",
            "description":"Advice Date"
        }
    }
}

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

{
    "type":"object",
    "description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.",
    "properties":{
        "adjustmentType":{
            "type":"string",
            "maxLength":8,
            "description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.",
            "example":"CUSTREL"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : approvalRequest

Type: object

Show Source

• _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.

{
    "type":"object",
    "properties":{
        "approvalRequestId":{
            "type":"string",
            "maxLength":12,
            "description":"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."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : calculationDetails

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rateSchedule":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Rate Schedule"
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Sequence is the system-assigned unique identifier of the calculation detail row.",
                                    "example":"1"
                                },
                                "descriptionOnBill":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Description on Bill is the information about the calculation line that appears on the customer's bill.",
                                    "example":"Base Adjustment Amount"
                                },
                                "auditCalculatedAmount":{
                                    "type":"number",
                                    "maximum":1.0E13,
                                    "minimum":-1.0E13,
                                    "description":"Calculated Amount is the calculated amount associated with the calculation line.",
                                    "example":"1.23000"
                                },
                                "shouldPrint":{
                                    "type":"boolean",
                                    "description":"Define Print as true to print this line on the customer's bill.",
                                    "example":"true"
                                },
                                "shouldAppearInSummary":{
                                    "type":"boolean",
                                    "description":"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"
                                },
                                "unitOfMeasure":{
                                    "type":"object",
                                    "properties":{
                                        "unitOfMeasure":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Unit of Measure"
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                },
                                "timeOfUse":{
                                    "type":"object",
                                    "properties":{
                                        "timeOfUse":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Time of Use"
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                },
                                "serviceQuantityIdentifier":{
                                    "type":"object",
                                    "properties":{
                                        "serviceQuantityIdentifier":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"SQI"
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                },
                                "billableServiceQuantity":{
                                    "type":"number",
                                    "maximum":1.0E12,
                                    "minimum":-1.0E12,
                                    "description":"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"
                                },
                                "baseAmount":{
                                    "type":"number",
                                    "description":"Base Amount"
                                },
                                "currency":{
                                    "type":"string",
                                    "maxLength":3,
                                    "description":"Currency Code"
                                },
                                "rateCompSequence":{
                                    "type":"number",
                                    "maximum":9999,
                                    "minimum":-9999,
                                    "description":"Sequence"
                                },
                                "measuresPeakQuantity":{
                                    "type":"boolean",
                                    "description":"Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.",
                                    "example":"false"
                                },
                                "exemptAmount":{
                                    "type":"number",
                                    "description":"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"
                                },
                                "distributionCode":{
                                    "type":"object",
                                    "properties":{
                                        "distributionCode":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Distribution Code"
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                },
                                "description":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"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."
                                },
                                "calculationGroup":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Calculation Group"
                                },
                                "calculationRule":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Calculation Rule"
                                },
                                "characteristicType":{
                                    "type":"object",
                                    "properties":{
                                        "characteristicType":{
                                            "type":"string",
                                            "maxLength":8,
                                            "description":"Characteristic Type"
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                },
                                "characteristicValue":{
                                    "type":"string",
                                    "maxLength":16,
                                    "description":"Characteristic Value Indicates the value of the characteristic."
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

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.

{
    "type":"object",
    "description":"The Cancel Reason describes the reason for the cancelation.",
    "properties":{
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"The Cancel Reason describes the reason for the cancelation."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : characteristics

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence controls the order in which characteristics of the same type are displayed.",
                        "example":"1"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference."
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "description":"(value)"
                            },
                            "value2":{
                                "type":"string",
                                "description":"(value2)"
                            },
                            "value3":{
                                "type":"string",
                                "description":"(value3)"
                            },
                            "value4":{
                                "type":"string",
                                "description":"(value4)"
                            },
                            "value5":{
                                "type":"string",
                                "description":"(value5)"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"2"
                    }
                }
            }
        }
    }
}

Nested Schema : currency

Type: object

Show Source

• _link: string
  _link
• currency: string
  Maximum Length: 3

  Currency Code

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : nextActions

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "action":{
                "type":"string",
                "enum":[
                    "C1CN",
                    "C1DE",
                    "C1FR",
                    "C1GN",
                    "C1SA"
                ],
                "description":"Available actions for the  Adjustment\n* `C1CN` - Cancel,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1SA` - Submit For Approval"
            }
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• _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

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
            "example":"4000000099"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

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

{
    "type":"object",
    "description":"Service Agreement ID whose financial balance needs to be adjusted.",
    "properties":{
        "serviceAgreement":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : account

Type: object

Show Source

• _link: string
  _link
• accountId: string
  Maximum Length: 10

  Account ID is the account to which the adjustment is linked.

  Example: 1589800000

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID is the account to which the adjustment is linked.",
            "example":"1589800000"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : accountsPayableRequest

Type: object

Show Source

• _link: string
  _link
• autopayRequestId: string
  Maximum Length: 12

  A/P Request ID

{
    "type":"object",
    "properties":{
        "autopayRequestId":{
            "type":"string",
            "maxLength":12,
            "description":"A/P Request ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

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.

{
    "type":"object",
    "description":"Country defaults from the installation options. The address constituents may differ depending on the Country.",
    "properties":{
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country defaults from the installation options. The address constituents may differ depending on the Country."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

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

{
    "type":"object",
    "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
    "properties":{
        "paymentCurrency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
            "example":"USD"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rateSchedule":{
                "type":"string",
                "maxLength":8,
                "description":"Rate Schedule"
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "_data":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "sequence":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Sequence is the system-assigned unique identifier of the calculation detail row.",
                            "example":"1"
                        },
                        "descriptionOnBill":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Description on Bill is the information about the calculation line that appears on the customer's bill.",
                            "example":"Base Adjustment Amount"
                        },
                        "auditCalculatedAmount":{
                            "type":"number",
                            "maximum":1.0E13,
                            "minimum":-1.0E13,
                            "description":"Calculated Amount is the calculated amount associated with the calculation line.",
                            "example":"1.23000"
                        },
                        "shouldPrint":{
                            "type":"boolean",
                            "description":"Define Print as true to print this line on the customer's bill.",
                            "example":"true"
                        },
                        "shouldAppearInSummary":{
                            "type":"boolean",
                            "description":"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"
                        },
                        "unitOfMeasure":{
                            "type":"object",
                            "properties":{
                                "unitOfMeasure":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Unit of Measure"
                                },
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                }
                            }
                        },
                        "timeOfUse":{
                            "type":"object",
                            "properties":{
                                "timeOfUse":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Time of Use"
                                },
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                }
                            }
                        },
                        "serviceQuantityIdentifier":{
                            "type":"object",
                            "properties":{
                                "serviceQuantityIdentifier":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"SQI"
                                },
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                }
                            }
                        },
                        "billableServiceQuantity":{
                            "type":"number",
                            "maximum":1.0E12,
                            "minimum":-1.0E12,
                            "description":"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"
                        },
                        "baseAmount":{
                            "type":"number",
                            "description":"Base Amount"
                        },
                        "currency":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Currency Code"
                        },
                        "rateCompSequence":{
                            "type":"number",
                            "maximum":9999,
                            "minimum":-9999,
                            "description":"Sequence"
                        },
                        "measuresPeakQuantity":{
                            "type":"boolean",
                            "description":"Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.",
                            "example":"false"
                        },
                        "exemptAmount":{
                            "type":"number",
                            "description":"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"
                        },
                        "distributionCode":{
                            "type":"object",
                            "properties":{
                                "distributionCode":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Distribution Code"
                                },
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                }
                            }
                        },
                        "description":{
                            "type":"string",
                            "maxLength":100,
                            "description":"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."
                        },
                        "calculationGroup":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Calculation Group"
                        },
                        "calculationRule":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Calculation Rule"
                        },
                        "characteristicType":{
                            "type":"object",
                            "properties":{
                                "characteristicType":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"Characteristic Type"
                                },
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                }
                            }
                        },
                        "characteristicValue":{
                            "type":"string",
                            "maxLength":16,
                            "description":"Characteristic Value Indicates the value of the characteristic."
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• _data: array _data
• effectiveDate: string (date)
  Effective Date
• rateSchedule: string
  Maximum Length: 8

  Rate Schedule

{
    "type":"object",
    "properties":{
        "rateSchedule":{
            "type":"string",
            "maxLength":8,
            "description":"Rate Schedule"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Sequence is the system-assigned unique identifier of the calculation detail row.",
                        "example":"1"
                    },
                    "descriptionOnBill":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Description on Bill is the information about the calculation line that appears on the customer's bill.",
                        "example":"Base Adjustment Amount"
                    },
                    "auditCalculatedAmount":{
                        "type":"number",
                        "maximum":1.0E13,
                        "minimum":-1.0E13,
                        "description":"Calculated Amount is the calculated amount associated with the calculation line.",
                        "example":"1.23000"
                    },
                    "shouldPrint":{
                        "type":"boolean",
                        "description":"Define Print as true to print this line on the customer's bill.",
                        "example":"true"
                    },
                    "shouldAppearInSummary":{
                        "type":"boolean",
                        "description":"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"
                    },
                    "unitOfMeasure":{
                        "type":"object",
                        "properties":{
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "timeOfUse":{
                        "type":"object",
                        "properties":{
                            "timeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "serviceQuantityIdentifier":{
                        "type":"object",
                        "properties":{
                            "serviceQuantityIdentifier":{
                                "type":"string",
                                "maxLength":30,
                                "description":"SQI"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "billableServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"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"
                    },
                    "baseAmount":{
                        "type":"number",
                        "description":"Base Amount"
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code"
                    },
                    "rateCompSequence":{
                        "type":"number",
                        "maximum":9999,
                        "minimum":-9999,
                        "description":"Sequence"
                    },
                    "measuresPeakQuantity":{
                        "type":"boolean",
                        "description":"Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.",
                        "example":"false"
                    },
                    "exemptAmount":{
                        "type":"number",
                        "description":"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"
                    },
                    "distributionCode":{
                        "type":"object",
                        "properties":{
                            "distributionCode":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Distribution Code"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "description":{
                        "type":"string",
                        "maxLength":100,
                        "description":"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."
                    },
                    "calculationGroup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Calculation Group"
                    },
                    "calculationRule":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Calculation Rule"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "characteristicValue":{
                        "type":"string",
                        "maxLength":16,
                        "description":"Characteristic Value Indicates the value of the characteristic."
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Sequence is the system-assigned unique identifier of the calculation detail row.",
                "example":"1"
            },
            "descriptionOnBill":{
                "type":"string",
                "maxLength":254,
                "description":"Description on Bill is the information about the calculation line that appears on the customer's bill.",
                "example":"Base Adjustment Amount"
            },
            "auditCalculatedAmount":{
                "type":"number",
                "maximum":1.0E13,
                "minimum":-1.0E13,
                "description":"Calculated Amount is the calculated amount associated with the calculation line.",
                "example":"1.23000"
            },
            "shouldPrint":{
                "type":"boolean",
                "description":"Define Print as true to print this line on the customer's bill.",
                "example":"true"
            },
            "shouldAppearInSummary":{
                "type":"boolean",
                "description":"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"
            },
            "unitOfMeasure":{
                "type":"object",
                "properties":{
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "timeOfUse":{
                "type":"object",
                "properties":{
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "serviceQuantityIdentifier":{
                "type":"object",
                "properties":{
                    "serviceQuantityIdentifier":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "billableServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"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"
            },
            "baseAmount":{
                "type":"number",
                "description":"Base Amount"
            },
            "currency":{
                "type":"string",
                "maxLength":3,
                "description":"Currency Code"
            },
            "rateCompSequence":{
                "type":"number",
                "maximum":9999,
                "minimum":-9999,
                "description":"Sequence"
            },
            "measuresPeakQuantity":{
                "type":"boolean",
                "description":"Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.",
                "example":"false"
            },
            "exemptAmount":{
                "type":"number",
                "description":"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"
            },
            "distributionCode":{
                "type":"object",
                "properties":{
                    "distributionCode":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Distribution Code"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "description":{
                "type":"string",
                "maxLength":100,
                "description":"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."
            },
            "calculationGroup":{
                "type":"string",
                "maxLength":30,
                "description":"Calculation Group"
            },
            "calculationRule":{
                "type":"string",
                "maxLength":30,
                "description":"Calculation Rule"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "characteristicValue":{
                "type":"string",
                "maxLength":16,
                "description":"Characteristic Value Indicates the value of the characteristic."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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: string
  Maximum Length: 3

  Currency Code
• 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

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence is the system-assigned unique identifier of the calculation detail row.",
            "example":"1"
        },
        "descriptionOnBill":{
            "type":"string",
            "maxLength":254,
            "description":"Description on Bill is the information about the calculation line that appears on the customer's bill.",
            "example":"Base Adjustment Amount"
        },
        "auditCalculatedAmount":{
            "type":"number",
            "maximum":1.0E13,
            "minimum":-1.0E13,
            "description":"Calculated Amount is the calculated amount associated with the calculation line.",
            "example":"1.23000"
        },
        "shouldPrint":{
            "type":"boolean",
            "description":"Define Print as true to print this line on the customer's bill.",
            "example":"true"
        },
        "shouldAppearInSummary":{
            "type":"boolean",
            "description":"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"
        },
        "unitOfMeasure":{
            "type":"object",
            "properties":{
                "unitOfMeasure":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Unit of Measure"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "timeOfUse":{
            "type":"object",
            "properties":{
                "timeOfUse":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Time of Use"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "serviceQuantityIdentifier":{
            "type":"object",
            "properties":{
                "serviceQuantityIdentifier":{
                    "type":"string",
                    "maxLength":30,
                    "description":"SQI"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "billableServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"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"
        },
        "baseAmount":{
            "type":"number",
            "description":"Base Amount"
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "rateCompSequence":{
            "type":"number",
            "maximum":9999,
            "minimum":-9999,
            "description":"Sequence"
        },
        "measuresPeakQuantity":{
            "type":"boolean",
            "description":"Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.",
            "example":"false"
        },
        "exemptAmount":{
            "type":"number",
            "description":"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"
        },
        "distributionCode":{
            "type":"object",
            "properties":{
                "distributionCode":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Distribution Code"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "description":{
            "type":"string",
            "maxLength":100,
            "description":"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."
        },
        "calculationGroup":{
            "type":"string",
            "maxLength":30,
            "description":"Calculation Group"
        },
        "calculationRule":{
            "type":"string",
            "maxLength":30,
            "description":"Calculation Rule"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "characteristicValue":{
            "type":"string",
            "maxLength":16,
            "description":"Characteristic Value Indicates the value of the characteristic."
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• _link: string
  _link
• characteristicType: string
  Maximum Length: 8

  Characteristic Type

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : distributionCode

Type: object

Show Source

• _link: string
  _link
• distributionCode: string
  Maximum Length: 10

  Distribution Code

{
    "type":"object",
    "properties":{
        "distributionCode":{
            "type":"string",
            "maxLength":10,
            "description":"Distribution Code"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : serviceQuantityIdentifier

Type: object

Show Source

• _link: string
  _link
• serviceQuantityIdentifier: string
  Maximum Length: 30

  SQI

{
    "type":"object",
    "properties":{
        "serviceQuantityIdentifier":{
            "type":"string",
            "maxLength":30,
            "description":"SQI"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : timeOfUse

Type: object

Show Source

• _link: string
  _link
• timeOfUse: string
  Maximum Length: 30

  Time of Use

{
    "type":"object",
    "properties":{
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : unitOfMeasure

Type: object

Show Source

• _link: string
  _link
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure

{
    "type":"object",
    "properties":{
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence controls the order in which characteristics of the same type are displayed.",
                "example":"1"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "maxLength":4,
                "description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference."
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "description":"(value)"
                    },
                    "value2":{
                        "type":"string",
                        "description":"(value2)"
                    },
                    "value3":{
                        "type":"string",
                        "description":"(value3)"
                    },
                    "value4":{
                        "type":"string",
                        "description":"(value4)"
                    },
                    "value5":{
                        "type":"string",
                        "description":"(value5)"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The Version number is used for internal concurrency checks.",
                "example":"2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence controls the order in which characteristics of the same type are displayed.",
            "example":"1"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "maxLength":4,
            "description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference."
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "description":"(value)"
                },
                "value2":{
                    "type":"string",
                    "description":"(value2)"
                },
                "value3":{
                    "type":"string",
                    "description":"(value3)"
                },
                "value4":{
                    "type":"string",
                    "description":"(value4)"
                },
                "value5":{
                    "type":"string",
                    "description":"(value5)"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"2"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• _link: string
  _link
• characteristicType: string
  Maximum Length: 8

  Characteristic Type

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

• _link: string
  (_link)
• value: string
  (value)
• value2: string
  (value2)
• value3: string
  (value3)
• value4: string
  (value4)
• value5: string
  (value5)

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"(value)"
        },
        "value2":{
            "type":"string",
            "description":"(value2)"
        },
        "value3":{
            "type":"string",
            "description":"(value3)"
        },
        "value4":{
            "type":"string",
            "description":"(value4)"
        },
        "value5":{
            "type":"string",
            "description":"(value5)"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "C1CN",
                "C1DE",
                "C1FR",
                "C1GN",
                "C1SA"
            ],
            "description":"Available actions for the  Adjustment\n* `C1CN` - Cancel,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1SA` - Submit For Approval"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top