Jump to

• Request
• Response

Get Service Agreement

get

https://server:port/spl/rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}

This Operation handles the Integration Suite API to Get Service Agreement.

Request

Path Parameters

• serviceAgreementId(required): string

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 : C1-ServiceAg

Type: object

Show Source

• _self: string
  _self
• account: object account
• allowEstimates: boolean
  Allow Estimates defines whether to allow the billing process to estimate this service agreement's consumption if a real meter read is missing at billing time. Disabling this support prohibits estimate meter reads.
• billMessages: object billMessages
• businessActivityDescription: string
  Maximum Length: 250

  Business Activity further defines what types of activities are served by the contract.

  Example: business
• characteristics: object characteristics
• consumerContractProducts: object consumerContractProducts
• contractOptions: object contractOptions
• contractQuantities: object contractQuantities
• contractTerms: object contractTerms
• currency: object currency
  Currency Code defines the currency in which the rate's prices are expressed.
• customerRead: string
  Allowed Values: [ "N ", "Y " ]

  Customer Read defines whether a customer read is from the customer's meter.

  Example: Y
• depositInterestCalculated: string (date)
  Deposit Interest Calculated contains the last date the system applied interest. This field is only visible if the SA type has a special role of Cash Deposit.

  Example: 2018-02-25
• division: object division
  The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.
• endDate: string (date)
  The End Date defines when the financial relationship terminates.

  Example: 2018-02-25
• expireDate: string (date)
  Expiration Date contains the date at which the service agreement is set to expire.
• ibSACutoffTime: string
  If the SA Type has a special role of Interval, you must enter the Cutoff Time. The Cutoff Time is entered in "legal time". This value defaults from either the start option or the installation record.
• maxBillThreshold: number
  Maximum Bill Threshold defines the maximum value for a bill segment that is produced in batch. If this value is exceeded, the system generates a bill error.

  Example: 2000
• nonBillAutoPay: string
  Allowed Values: [ "EXCL", "INCL" ]

  The Scheduled Payment Autopay defines whether the non-billed budget scheduled payments are excluded from automatic payment or included by automatic payment. If the account is not set up for automatic payment for the period that covers the non-billed budget, this flag cannot be set. This field is only applicable if the service agreement has a special role of Non-billed Budget.

  Example: INCL
• numberOfPaymentPeriods: number
  Minimum Value: 0

  Maximum Value: 999

  Number of Payment Periods only appears for loan SA types. It displays the number of periods specified when the loan was first activated.

  Example: 0
• oldAccountId: string
  Maximum Length: 36

  Old Account ID refers to account ID for service agreements that were converted from a legacy CIS system. The payment upload process uses this field to locate the accounts for payments that reference a legacy account number.

  Example: 123456789
• order: object order
• premise: object premise
• rateScheduleHistory: object rateScheduleHistory
• recommendationRule: string
  Maximum Length: 8

  The NBB Recommendation Rule displays the description of the non-billed budget recommendation rule used for this service agreement. This field is only applicable if the service agreement has a special role of Non-billed Budget.
• recurringChargeHistory: object recurringChargeHistory
• renewalDate: string (date)
  Renewal Date contains the date at which the service agreement is to be renewed. Renewal date is disabled if renewal is not allowed on the SA type.
• reviewDate: string (date)
  CIAC Review Date displays the last date that the Contributions In Aid of Construction (CIAC) review process ran for this service agreement. This field is only visible if the SA type indicates that it is a CIAC service agreement.
• serviceAgreementId: string
  Maximum Length: 10

  The Service Agreement ID is a system assigned random number that stays with a service agreement for life.
• serviceAgreementRelationship: object serviceAgreementRelationship
• serviceAgreementType: object serviceAgreementType
• servicePoints: object servicePoints
• sicCode: object sicCode
  Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.
• specialUsage: string
  Allowed Values: [ "PROP" ]

  The Special Usage Flag defines proposal service agreements. Quote creation requires an account has at least one proposal service agreement. A proposal service agreement contains the pricing terms, legal terms, and template consumption used to generate the simulated bill segments that appear on a quote. It might be helpful to view a proposal service agreement as special type of service agreement that is ignored when a bill is produced for an account.

  Example: PROP
• startDate: string (date)
  The Start Date defines when the financial relationship begins.
• startOption: string
  Maximum Length: 12

  Start options define default values for a service agreement. For example, the rate schedule, recurring charge amount, contract riders, contract terms, characteristics, terms and conditions, and so on can all be defaulted onto a service agreement using a start option.
• startReason: string
  Allowed Values: [ "C ", "S " ]

  Start Reason defines if a customer or the system requested to start the service agreement.

  Example: C
• startRequestedBy: string
  Maximum Length: 50

  Start Requested By can include notes entered in the Requested By field when the service agreement start is submitted. For example, Customer, Jane Smith.
• status: string
  Allowed Values: [ "05 ", "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]

  SA Status defines the state of the service agreement. * `05 ` - Incomplete, * `10 ` - Pending Start, * `20 ` - Active, * `30 ` - Pending Stop, * `40 ` - Stopped, * `50 ` - Reactivated, * `60 ` - Closed, * `70 ` - Canceled

  Example: 20
• stopReason: string
  Allowed Values: [ "C ", "S " ]

  Stop Reason defines if a customer or the system requested to stop the service agreement.

  Example: C
• stopRequestedBy: string
  Maximum Length: 50

  Stop Requested By can capture notes entered in the Requested By field when this SA stop was submitted (e.g., Customer, Jane Smith ).
• termsAndConditions: object termsAndConditions
• totalAmountToBill: number
  If the service agreement requires a total amount to bill, the amount is displayed. This field is typically only used on loan or cash deposit service agreements.
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

  Example: 2

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"The Service Agreement ID is a system assigned random number that stays with a service agreement for life."
        },
        "status":{
            "type":"string",
            "enum":[
                "05  ",
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"SA Status defines the state of the service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled",
            "example":"20"
        },
        "account":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID defines the account that is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement, and its debt, to the new account.",
                    "example":"1589809012"
                }
            }
        },
        "division":{
            "type":"object",
            "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "division":{
                    "type":"string",
                    "maxLength":5,
                    "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                    "example":"Ohio"
                }
            }
        },
        "serviceAgreementType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceAgreementType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"SA Type"
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"The Start Date defines when the financial relationship begins."
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"The End Date defines when the financial relationship terminates.",
            "example":"2018-02-25"
        },
        "customerRead":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"Customer Read defines whether a customer read is from the customer's meter.",
            "example":"Y"
        },
        "allowEstimates":{
            "type":"boolean",
            "description":"Allow Estimates defines whether to allow the billing process to estimate this service agreement's consumption if a real meter read is missing at billing time. Disabling this support prohibits estimate meter reads."
        },
        "startOption":{
            "type":"string",
            "maxLength":12,
            "description":"Start options define default values for a service agreement. For example, the rate schedule, recurring charge amount, contract riders, contract terms, characteristics, terms and conditions, and so on can all be defaulted onto a service agreement using a start option."
        },
        "premise":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"If the service agreement's rate uses premise-based characteristics for taxation and other purposes, Characteristic Premise ID defines the premise that supplies these characteristics. This field also defines the premise under which the service agreement's bill segments are classified and is used to identify where the service agreement's service is located.",
                    "example":"8614900960"
                }
            }
        },
        "oldAccountId":{
            "type":"string",
            "maxLength":36,
            "description":"Old Account ID refers to account ID for service agreements that were converted from a legacy CIS system. The payment upload process uses this field to locate the accounts for payments that reference a legacy account number.",
            "example":"123456789"
        },
        "totalAmountToBill":{
            "type":"number",
            "description":"If the service agreement requires a total amount to bill, the amount is displayed. This field is typically only used on loan or cash deposit service agreements."
        },
        "expireDate":{
            "type":"string",
            "format":"date",
            "description":"Expiration Date contains the date at which the service agreement is set to expire."
        },
        "renewalDate":{
            "type":"string",
            "format":"date",
            "description":"Renewal Date contains the date at which the service agreement is to be renewed. Renewal date is disabled if renewal is not allowed on the SA type."
        },
        "serviceAgreementRelationship":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceAgreementRelationshipId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"SA Relationship ID"
                }
            }
        },
        "sicCode":{
            "type":"object",
            "description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "sicCode":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.",
                    "example":"4800 (Transportation)"
                }
            }
        },
        "currency":{
            "type":"object",
            "description":"Currency Code defines the currency in which the rate's prices are expressed.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code defines the currency in which the rate's prices are expressed.",
                    "example":"USD"
                }
            }
        },
        "maxBillThreshold":{
            "type":"number",
            "description":"Maximum Bill Threshold defines the maximum value for a bill segment that is produced in batch. If this value is exceeded, the system generates a bill error.",
            "example":"2000"
        },
        "depositInterestCalculated":{
            "type":"string",
            "format":"date",
            "description":"Deposit Interest Calculated contains the last date the system applied interest. This field is only visible if the SA type has a special role of Cash Deposit.",
            "example":"2018-02-25"
        },
        "reviewDate":{
            "type":"string",
            "format":"date",
            "description":"CIAC Review Date displays the last date that the Contributions In Aid of Construction (CIAC) review process ran for this service agreement. This field is only visible if the SA type indicates that it is a CIAC service agreement."
        },
        "startReason":{
            "type":"string",
            "enum":[
                "C   ",
                "S   "
            ],
            "description":"Start Reason defines if a customer or the system requested to start the service agreement.",
            "example":"C"
        },
        "stopReason":{
            "type":"string",
            "enum":[
                "C   ",
                "S   "
            ],
            "description":"Stop Reason defines  if a customer or the system requested to stop the service agreement.",
            "example":"C"
        },
        "startRequestedBy":{
            "type":"string",
            "maxLength":50,
            "description":"Start Requested By can include notes entered in the Requested By field when the service agreement start is submitted. For example, Customer, Jane Smith."
        },
        "stopRequestedBy":{
            "type":"string",
            "maxLength":50,
            "description":"Stop Requested By can capture notes entered in the Requested By field when this SA stop was submitted (e.g., Customer, Jane Smith )."
        },
        "businessActivityDescription":{
            "type":"string",
            "maxLength":250,
            "description":"Business Activity further defines what types of activities are served by the contract.",
            "example":"business"
        },
        "order":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "orderId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Order ID is the system-assigned unique identifier of the order."
                }
            }
        },
        "ibSACutoffTime":{
            "type":"string",
            "description":"If the SA Type has a special role of Interval, you must enter the Cutoff Time. The Cutoff Time is entered in \"legal time\". This value defaults from either the start option or the installation record."
        },
        "specialUsage":{
            "type":"string",
            "enum":[
                "PROP"
            ],
            "description":"The Special Usage Flag defines  proposal service agreements. Quote creation requires an account has at least one proposal service agreement. A proposal service agreement contains the pricing terms, legal terms, and template consumption used to generate the simulated bill segments that appear on a quote. It might be helpful to view a proposal service agreement as special type of service agreement that is ignored when a bill is produced for an account.",
            "example":"PROP"
        },
        "numberOfPaymentPeriods":{
            "type":"number",
            "maximum":999,
            "minimum":0,
            "description":"Number of Payment Periods only appears for loan SA types. It displays the number of periods specified when the loan was first activated.",
            "example":"0"
        },
        "recommendationRule":{
            "type":"string",
            "maxLength":8,
            "description":"The NBB Recommendation Rule displays the description of the non-billed budget recommendation rule used for this service agreement. This field is only applicable if the service agreement has a special role of Non-billed Budget."
        },
        "nonBillAutoPay":{
            "type":"string",
            "enum":[
                "EXCL",
                "INCL"
            ],
            "description":"The Scheduled Payment Autopay defines whether the non-billed budget scheduled payments are excluded from automatic payment or included by automatic payment. If the account is not set up for automatic payment for the period that covers the non-billed budget, this flag cannot be set. This field is only applicable if the service agreement has a special role of Non-billed Budget.",
            "example":"INCL"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version",
            "example":"2"
        },
        "consumerContractProducts":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "consumerContractProduct":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "consumerContractProductId":{
                                        "type":"string",
                                        "maxLength":14,
                                        "description":"Consumer Contract Product"
                                    }
                                }
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date indicates the effective date of the characteristic type and value. The service point's install date is the default value.",
                                "example":"2018-02-25"
                            },
                            "consumerContractRule":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "consumerContractRule":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Consumer Contract Rule"
                                    }
                                }
                            },
                            "consumerProductComponent":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "consumerProductComponent":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Consumer Product Component"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version",
                                "example":"2"
                            }
                        }
                    }
                }
            }
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.",
                                "example":"2018-02-25"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type indicates the type of characteristic."
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Type of Char Value"
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    },
                                    "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)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version",
                                "example":"2"
                            }
                        }
                    }
                }
            }
        },
        "contractTerms":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "contractTermType":{
                                "type":"string",
                                "enum":[
                                    "R   ",
                                    "T   ",
                                    "V   "
                                ],
                                "description":"Billing uses Contract Term information when it calculates a bill segment for the service agreement. The Contract Rider type contains the contract riders that are in effect for the service agreement. The Contract Value type contains the contract values that are in effect for the service agreement. The Tax Exemptions type contains the taxes from which the service agreement is all or partially exempt.",
                                "example":"R"
                            },
                            "billFactor":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "billFactor":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Bill Factor defines the type of contract rider."
                                    }
                                }
                            },
                            "startDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Start Date defines the date on which the contract rider becomes effective. The service agreement's start date acts as the default value."
                            },
                            "endDate":{
                                "type":"string",
                                "format":"date",
                                "description":"End Date defines the date on which the contract rider expires.",
                                "example":"2018-02-25"
                            },
                            "percentExempt":{
                                "type":"number",
                                "maximum":999.9999,
                                "minimum":-999.9999,
                                "description":"Percent Exempt defines the customer tax exemption percent. For example, 90 means the customer is 90% exempt and will only pay 10% of the normal tax rate.",
                                "example":"0.0000"
                            },
                            "taxCertification":{
                                "type":"string",
                                "maxLength":35,
                                "description":"Tax Certification defines whether the customer has a tax exemption certificate."
                            },
                            "taxExemptType":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "taxExemptType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Tax Exempt Type defines the type of exemption."
                                    }
                                }
                            },
                            "touGroup":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Indicate the TOU Group that corresponds with the TOU group on the service agreement's TOU Map. Once entered, the collection of TOU codes linked to this TOU group will display."
                            },
                            "value":{
                                "type":"number",
                                "maximum":1.0E11,
                                "minimum":-1.0E11,
                                "description":"Defines the time of use code value."
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version",
                                "example":"2"
                            }
                        }
                    }
                }
            }
        },
        "contractQuantities":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "contractQuantityType":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "contractQuantityType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Contract Quantity Type defines the type of contract quantity."
                                    }
                                }
                            },
                            "contractQuantity":{
                                "type":"number",
                                "maximum":1.0E11,
                                "minimum":-1.0E11,
                                "description":"The contract quantity defines the contract quantity.",
                                "example":"10.000000"
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date defines the date the charge becomes effective. The service agreement's start date acts as the default value.",
                                "example":"2018-02-25"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version",
                                "example":"2"
                            }
                        }
                    }
                }
            }
        },
        "contractOptions":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "saContractOptionId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"The SA Contract Option ID is the unique identifier of the service agreement or contract option record.",
                                "example":"301631110794"
                            },
                            "contractOption":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "contractOptionId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Contract Option ID is a system assigned record key for the contract option linked to the Service Agreement."
                                    }
                                }
                            },
                            "effectiveDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Effective Date/Time is the date and time that the contract option is in effect for the service agreement.",
                                "example":"2018-02-25"
                            },
                            "expirationDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Expiration Date/Time is the date and time that the contract option is no longer in effect for the service agreement.",
                                "example":"2006-07-01T00:00:00-04:00"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version",
                                "example":"2"
                            }
                        }
                    }
                }
            }
        },
        "billMessages":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "billMessage":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "billMessage":{
                                        "type":"string",
                                        "maxLength":4,
                                        "description":"Bill Message"
                                    }
                                }
                            },
                            "billMessageType":{
                                "type":"string",
                                "enum":[
                                    "P   ",
                                    "T   "
                                ],
                                "description":"For Bill Message Type, use Temporary to indicate the message should only be linked to the next bill produced for the account. Use Permanent if the message should appear on every bill. Temporary is the default value.",
                                "example":"T"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version",
                                "example":"2"
                            }
                        }
                    }
                }
            }
        },
        "recurringChargeHistory":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date is the date the charge becomes effective. The service agreement's start date acts as the default value.",
                                "example":"2018-02-25"
                            },
                            "recurringChargeAmount":{
                                "type":"number",
                                "description":"The Recurring Charge contains effective-dated information that defines the recurring charge amount used to calculate the service agreement's bill segments.",
                                "example":"5000"
                            },
                            "currency":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "currency":{
                                        "type":"string",
                                        "maxLength":3,
                                        "description":"Currency Code defines the currency in which the rate's prices are expressed."
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version",
                                "example":"2"
                            }
                        }
                    }
                }
            }
        },
        "rateScheduleHistory":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date is the date the rate becomes effective. The service agreement's start date acts as the default value.",
                                "example":"2018-02-25"
                            },
                            "rateSchedule":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "rateSchedule":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version",
                                "example":"2"
                            }
                        }
                    }
                }
            }
        },
        "servicePoints":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "servicePoint":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "servicePointId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Point ID is the identifier of the service point."
                                    }
                                }
                            },
                            "saSPId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"System assigned record key for the SA/SP relationship."
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Start Date/Time The date and time the service point's consumption starts being billed under the service agreement."
                            },
                            "startMeterRead":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "startMeterReadId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"ID of the meter reading record at the time the service point was started for the service agreement."
                                    }
                                }
                            },
                            "stopDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The date and time the service point's consumption stops being billed under the service agreement."
                            },
                            "howToUseRead":{
                                "type":"string",
                                "enum":[
                                    "+   ",
                                    "-   ",
                                    "C   ",
                                    "S   ",
                                    "X   "
                                ],
                                "description":"How to Use (SP) indicates how billing uses the consumption associated with the service point. This is not applicable for item-type service points.",
                                "example":"S"
                            },
                            "stopMeterRead":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "stopMeterReadId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Stop Meter Read is the meter read that records the register values as they appeared when the service point was unlinked from the service agreement."
                                    }
                                }
                            },
                            "usePercent":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Use Percent indicates the percentage of this service point's consumption that is billed under the service agreement. This field is not applicable for item-type service points.",
                                "example":"100"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version",
                                "example":"2"
                            }
                        }
                    }
                }
            }
        },
        "termsAndConditions":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "termsAndCondition":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "termsAndCondition":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Terms and Conditions define the type of terms and conditions.",
                                        "example":"NGSCC-01"
                                    }
                                }
                            },
                            "startDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Start Date defines the date on which the terms and conditions become effective. The service agreement's start date acts as the default value."
                            },
                            "endDate":{
                                "type":"string",
                                "format":"date",
                                "description":"End Date defines the date on which the terms and conditions expire. This field is only applicable if the terms and conditions expire on an explicit date.",
                                "example":"2018-02-25"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version",
                                "example":"2"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-ServiceAg"
    }
}

Nested Schema : account

Type: object

Show Source

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

  Account ID defines the account that is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement, and its debt, to the new account.

  Example: 1589809012

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID defines the account that is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement, and its debt, to the new account.",
            "example":"1589809012"
        }
    }
}

Nested Schema : billMessages

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "billMessage":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "billMessage":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Bill Message"
                            }
                        }
                    },
                    "billMessageType":{
                        "type":"string",
                        "enum":[
                            "P   ",
                            "T   "
                        ],
                        "description":"For Bill Message Type, use Temporary to indicate the message should only be linked to the next bill produced for the account. Use Permanent if the message should appear on every bill. Temporary is the default value.",
                        "example":"T"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version",
                        "example":"2"
                    }
                }
            }
        }
    }
}

Nested Schema : characteristics

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.",
                        "example":"2018-02-25"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type indicates the type of characteristic."
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Type of Char Value"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            },
                            "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)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version",
                        "example":"2"
                    }
                }
            }
        }
    }
}

Nested Schema : consumerContractProducts

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "consumerContractProduct":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "consumerContractProductId":{
                                "type":"string",
                                "maxLength":14,
                                "description":"Consumer Contract Product"
                            }
                        }
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date indicates the effective date of the characteristic type and value. The service point's install date is the default value.",
                        "example":"2018-02-25"
                    },
                    "consumerContractRule":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "consumerContractRule":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Consumer Contract Rule"
                            }
                        }
                    },
                    "consumerProductComponent":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "consumerProductComponent":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Consumer Product Component"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version",
                        "example":"2"
                    }
                }
            }
        }
    }
}

Nested Schema : contractOptions

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "saContractOptionId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The SA Contract Option ID is the unique identifier of the service agreement or contract option record.",
                        "example":"301631110794"
                    },
                    "contractOption":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "contractOptionId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Contract Option ID is a system assigned record key for the contract option linked to the Service Agreement."
                            }
                        }
                    },
                    "effectiveDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Effective Date/Time is the date and time that the contract option is in effect for the service agreement.",
                        "example":"2018-02-25"
                    },
                    "expirationDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Expiration Date/Time is the date and time that the contract option is no longer in effect for the service agreement.",
                        "example":"2006-07-01T00:00:00-04:00"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version",
                        "example":"2"
                    }
                }
            }
        }
    }
}

Nested Schema : contractQuantities

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "contractQuantityType":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "contractQuantityType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Contract Quantity Type defines the type of contract quantity."
                            }
                        }
                    },
                    "contractQuantity":{
                        "type":"number",
                        "maximum":1.0E11,
                        "minimum":-1.0E11,
                        "description":"The contract quantity defines the contract quantity.",
                        "example":"10.000000"
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date defines the date the charge becomes effective. The service agreement's start date acts as the default value.",
                        "example":"2018-02-25"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version",
                        "example":"2"
                    }
                }
            }
        }
    }
}

Nested Schema : contractTerms

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "contractTermType":{
                        "type":"string",
                        "enum":[
                            "R   ",
                            "T   ",
                            "V   "
                        ],
                        "description":"Billing uses Contract Term information when it calculates a bill segment for the service agreement. The Contract Rider type contains the contract riders that are in effect for the service agreement. The Contract Value type contains the contract values that are in effect for the service agreement. The Tax Exemptions type contains the taxes from which the service agreement is all or partially exempt.",
                        "example":"R"
                    },
                    "billFactor":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "billFactor":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Bill Factor defines the type of contract rider."
                            }
                        }
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Start Date defines the date on which the contract rider becomes effective. The service agreement's start date acts as the default value."
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"End Date defines the date on which the contract rider expires.",
                        "example":"2018-02-25"
                    },
                    "percentExempt":{
                        "type":"number",
                        "maximum":999.9999,
                        "minimum":-999.9999,
                        "description":"Percent Exempt defines the customer tax exemption percent. For example, 90 means the customer is 90% exempt and will only pay 10% of the normal tax rate.",
                        "example":"0.0000"
                    },
                    "taxCertification":{
                        "type":"string",
                        "maxLength":35,
                        "description":"Tax Certification defines whether the customer has a tax exemption certificate."
                    },
                    "taxExemptType":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "taxExemptType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Tax Exempt Type defines the type of exemption."
                            }
                        }
                    },
                    "touGroup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Indicate the TOU Group that corresponds with the TOU group on the service agreement's TOU Map. Once entered, the collection of TOU codes linked to this TOU group will display."
                    },
                    "value":{
                        "type":"number",
                        "maximum":1.0E11,
                        "minimum":-1.0E11,
                        "description":"Defines the time of use code value."
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version",
                        "example":"2"
                    }
                }
            }
        }
    }
}

Nested Schema : currency

Type: object

Currency Code defines the currency in which the rate's prices are expressed.

Show Source

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

  Currency Code defines the currency in which the rate's prices are expressed.

  Example: USD

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

Nested Schema : division

Type: object

The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.

Show Source

• _link: string
  _link
• division: string
  Maximum Length: 5

  The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.

  Example: Ohio

{
    "type":"object",
    "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "division":{
            "type":"string",
            "maxLength":5,
            "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
            "example":"Ohio"
        }
    }
}

Nested Schema : order

Type: object

Show Source

• _link: string
  _link
• orderId: string
  Maximum Length: 12

  Order ID is the system-assigned unique identifier of the order.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "orderId":{
            "type":"string",
            "maxLength":12,
            "description":"Order ID is the system-assigned unique identifier of the order."
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• _link: string
  _link
• premiseId: string
  Maximum Length: 10

  If the service agreement's rate uses premise-based characteristics for taxation and other purposes, Characteristic Premise ID defines the premise that supplies these characteristics. This field also defines the premise under which the service agreement's bill segments are classified and is used to identify where the service agreement's service is located.

  Example: 8614900960

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"If the service agreement's rate uses premise-based characteristics for taxation and other purposes, Characteristic Premise ID defines the premise that supplies these characteristics. This field also defines the premise under which the service agreement's bill segments are classified and is used to identify where the service agreement's service is located.",
            "example":"8614900960"
        }
    }
}

Nested Schema : rateScheduleHistory

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date is the date the rate becomes effective. The service agreement's start date acts as the default value.",
                        "example":"2018-02-25"
                    },
                    "rateSchedule":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "rateSchedule":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version",
                        "example":"2"
                    }
                }
            }
        }
    }
}

Nested Schema : recurringChargeHistory

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date is the date the charge becomes effective. The service agreement's start date acts as the default value.",
                        "example":"2018-02-25"
                    },
                    "recurringChargeAmount":{
                        "type":"number",
                        "description":"The Recurring Charge contains effective-dated information that defines the recurring charge amount used to calculate the service agreement's bill segments.",
                        "example":"5000"
                    },
                    "currency":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code defines the currency in which the rate's prices are expressed."
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version",
                        "example":"2"
                    }
                }
            }
        }
    }
}

Nested Schema : serviceAgreementRelationship

Type: object

Show Source

• _link: string
  _link
• serviceAgreementRelationshipId: string
  Maximum Length: 10

  SA Relationship ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceAgreementRelationshipId":{
            "type":"string",
            "maxLength":10,
            "description":"SA Relationship ID"
        }
    }
}

Nested Schema : serviceAgreementType

Type: object

Show Source

• _link: string
  _link
• serviceAgreementType: string
  Maximum Length: 8

  SA Type

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceAgreementType":{
            "type":"string",
            "maxLength":8,
            "description":"SA Type"
        }
    }
}

Nested Schema : servicePoints

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "servicePoint":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "servicePointId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID is the identifier of the service point."
                            }
                        }
                    },
                    "saSPId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"System assigned record key for the SA/SP relationship."
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Start Date/Time The date and time the service point's consumption starts being billed under the service agreement."
                    },
                    "startMeterRead":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "startMeterReadId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"ID of the meter reading record at the time the service point was started for the service agreement."
                            }
                        }
                    },
                    "stopDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The date and time the service point's consumption stops being billed under the service agreement."
                    },
                    "howToUseRead":{
                        "type":"string",
                        "enum":[
                            "+   ",
                            "-   ",
                            "C   ",
                            "S   ",
                            "X   "
                        ],
                        "description":"How to Use (SP) indicates how billing uses the consumption associated with the service point. This is not applicable for item-type service points.",
                        "example":"S"
                    },
                    "stopMeterRead":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "stopMeterReadId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Stop Meter Read is the meter read that records the register values as they appeared when the service point was unlinked from the service agreement."
                            }
                        }
                    },
                    "usePercent":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Use Percent indicates the percentage of this service point's consumption that is billed under the service agreement. This field is not applicable for item-type service points.",
                        "example":"100"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version",
                        "example":"2"
                    }
                }
            }
        }
    }
}

Nested Schema : sicCode

Type: object

Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.

Show Source

• _link: string
  _link
• sicCode: string
  Maximum Length: 8

  Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.

  Example: 4800 (Transportation)

{
    "type":"object",
    "description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "sicCode":{
            "type":"string",
            "maxLength":8,
            "description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.",
            "example":"4800 (Transportation)"
        }
    }
}

Nested Schema : termsAndConditions

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "termsAndCondition":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "termsAndCondition":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Terms and Conditions define the type of terms and conditions.",
                                "example":"NGSCC-01"
                            }
                        }
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Start Date defines the date on which the terms and conditions become effective. The service agreement's start date acts as the default value."
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"End Date defines the date on which the terms and conditions expire. This field is only applicable if the terms and conditions expire on an explicit date.",
                        "example":"2018-02-25"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version",
                        "example":"2"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "billMessage":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "billMessage":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Bill Message"
                    }
                }
            },
            "billMessageType":{
                "type":"string",
                "enum":[
                    "P   ",
                    "T   "
                ],
                "description":"For Bill Message Type, use Temporary to indicate the message should only be linked to the next bill produced for the account. Use Permanent if the message should appear on every bill. Temporary is the default value.",
                "example":"T"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version",
                "example":"2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billMessage: object billMessage
• billMessageType: string
  Allowed Values: [ "P ", "T " ]

  For Bill Message Type, use Temporary to indicate the message should only be linked to the next bill produced for the account. Use Permanent if the message should appear on every bill. Temporary is the default value.

  Example: T
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

  Example: 2

{
    "type":"object",
    "properties":{
        "billMessage":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "billMessage":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Bill Message"
                }
            }
        },
        "billMessageType":{
            "type":"string",
            "enum":[
                "P   ",
                "T   "
            ],
            "description":"For Bill Message Type, use Temporary to indicate the message should only be linked to the next bill produced for the account. Use Permanent if the message should appear on every bill. Temporary is the default value.",
            "example":"T"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version",
            "example":"2"
        }
    }
}

Nested Schema : billMessage

Type: object

Show Source

• _link: string
  _link
• billMessage: string
  Maximum Length: 4

  Bill Message

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "billMessage":{
            "type":"string",
            "maxLength":4,
            "description":"Bill Message"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.",
                "example":"2018-02-25"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type indicates the type of characteristic."
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "maxLength":4,
                "description":"Type of Char Value"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    },
                    "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)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version",
                "example":"2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• effectiveDate: string (date)
  Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.

  Example: 2018-02-25
• typeOfCharacteristicValue: string
  Maximum Length: 4

  Type of Char Value
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

  Example: 2

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.",
            "example":"2018-02-25"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type indicates the type of characteristic."
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "maxLength":4,
            "description":"Type of Char Value"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                },
                "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)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version",
            "example":"2"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

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

  Characteristic Type indicates the type of characteristic.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type indicates the type of characteristic."
        }
    }
}

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":{
        "_link":{
            "type":"string",
            "description":"(_link)"
        },
        "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)"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "consumerContractProduct":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "consumerContractProductId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"Consumer Contract Product"
                    }
                }
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date indicates the effective date of the characteristic type and value. The service point's install date is the default value.",
                "example":"2018-02-25"
            },
            "consumerContractRule":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "consumerContractRule":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Consumer Contract Rule"
                    }
                }
            },
            "consumerProductComponent":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "consumerProductComponent":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Consumer Product Component"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version",
                "example":"2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• consumerContractProduct: object consumerContractProduct
• consumerContractRule: object consumerContractRule
• consumerProductComponent: object consumerProductComponent
• effectiveDate: string (date)
  Effective Date indicates the effective date of the characteristic type and value. The service point's install date is the default value.

  Example: 2018-02-25
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

  Example: 2

{
    "type":"object",
    "properties":{
        "consumerContractProduct":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "consumerContractProductId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"Consumer Contract Product"
                }
            }
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date indicates the effective date of the characteristic type and value. The service point's install date is the default value.",
            "example":"2018-02-25"
        },
        "consumerContractRule":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "consumerContractRule":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Consumer Contract Rule"
                }
            }
        },
        "consumerProductComponent":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "consumerProductComponent":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Consumer Product Component"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version",
            "example":"2"
        }
    }
}

Nested Schema : consumerContractProduct

Type: object

Show Source

• _link: string
  _link
• consumerContractProductId: string
  Maximum Length: 14

  Consumer Contract Product

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "consumerContractProductId":{
            "type":"string",
            "maxLength":14,
            "description":"Consumer Contract Product"
        }
    }
}

Nested Schema : consumerContractRule

Type: object

Show Source

• _link: string
  _link
• consumerContractRule: string
  Maximum Length: 30

  Consumer Contract Rule

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "consumerContractRule":{
            "type":"string",
            "maxLength":30,
            "description":"Consumer Contract Rule"
        }
    }
}

Nested Schema : consumerProductComponent

Type: object

Show Source

• _link: string
  _link
• consumerProductComponent: string
  Maximum Length: 30

  Consumer Product Component

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "consumerProductComponent":{
            "type":"string",
            "maxLength":30,
            "description":"Consumer Product Component"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "saContractOptionId":{
                "type":"string",
                "maxLength":12,
                "description":"The SA Contract Option ID is the unique identifier of the service agreement or contract option record.",
                "example":"301631110794"
            },
            "contractOption":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "contractOptionId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Contract Option ID is a system assigned record key for the contract option linked to the Service Agreement."
                    }
                }
            },
            "effectiveDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Effective Date/Time is the date and time that the contract option is in effect for the service agreement.",
                "example":"2018-02-25"
            },
            "expirationDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Expiration Date/Time is the date and time that the contract option is no longer in effect for the service agreement.",
                "example":"2006-07-01T00:00:00-04:00"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version",
                "example":"2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• contractOption: object contractOption
• effectiveDateTime: string (date-time)
  Effective Date/Time is the date and time that the contract option is in effect for the service agreement.

  Example: 2018-02-25
• expirationDateTime: string (date-time)
  Expiration Date/Time is the date and time that the contract option is no longer in effect for the service agreement.

  Example: 2006-07-01T00:00:00-04:00
• saContractOptionId: string
  Maximum Length: 12

  The SA Contract Option ID is the unique identifier of the service agreement or contract option record.

  Example: 301631110794
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

  Example: 2

{
    "type":"object",
    "properties":{
        "saContractOptionId":{
            "type":"string",
            "maxLength":12,
            "description":"The SA Contract Option ID is the unique identifier of the service agreement or contract option record.",
            "example":"301631110794"
        },
        "contractOption":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "contractOptionId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Contract Option ID is a system assigned record key for the contract option linked to the Service Agreement."
                }
            }
        },
        "effectiveDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Effective Date/Time is the date and time that the contract option is in effect for the service agreement.",
            "example":"2018-02-25"
        },
        "expirationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Expiration Date/Time is the date and time that the contract option is no longer in effect for the service agreement.",
            "example":"2006-07-01T00:00:00-04:00"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version",
            "example":"2"
        }
    }
}

Nested Schema : contractOption

Type: object

Show Source

• _link: string
  _link
• contractOptionId: string
  Maximum Length: 12

  Contract Option ID is a system assigned record key for the contract option linked to the Service Agreement.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "contractOptionId":{
            "type":"string",
            "maxLength":12,
            "description":"Contract Option ID is a system assigned record key for the contract option linked to the Service Agreement."
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "contractQuantityType":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "contractQuantityType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Contract Quantity Type defines the type of contract quantity."
                    }
                }
            },
            "contractQuantity":{
                "type":"number",
                "maximum":1.0E11,
                "minimum":-1.0E11,
                "description":"The contract quantity defines the contract quantity.",
                "example":"10.000000"
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date defines the date the charge becomes effective. The service agreement's start date acts as the default value.",
                "example":"2018-02-25"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version",
                "example":"2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• contractQuantity: number
  Minimum Value: -1.0E11

  Maximum Value: 1.0E11

  The contract quantity defines the contract quantity.

  Example: 10.000000
• contractQuantityType: object contractQuantityType
• effectiveDate: string (date)
  Effective Date defines the date the charge becomes effective. The service agreement's start date acts as the default value.

  Example: 2018-02-25
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

  Example: 2

{
    "type":"object",
    "properties":{
        "contractQuantityType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "contractQuantityType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Contract Quantity Type defines the type of contract quantity."
                }
            }
        },
        "contractQuantity":{
            "type":"number",
            "maximum":1.0E11,
            "minimum":-1.0E11,
            "description":"The contract quantity defines the contract quantity.",
            "example":"10.000000"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date defines the date the charge becomes effective. The service agreement's start date acts as the default value.",
            "example":"2018-02-25"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version",
            "example":"2"
        }
    }
}

Nested Schema : contractQuantityType

Type: object

Show Source

• _link: string
  _link
• contractQuantityType: string
  Maximum Length: 8

  Contract Quantity Type defines the type of contract quantity.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "contractQuantityType":{
            "type":"string",
            "maxLength":8,
            "description":"Contract Quantity Type defines the type of contract quantity."
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "contractTermType":{
                "type":"string",
                "enum":[
                    "R   ",
                    "T   ",
                    "V   "
                ],
                "description":"Billing uses Contract Term information when it calculates a bill segment for the service agreement. The Contract Rider type contains the contract riders that are in effect for the service agreement. The Contract Value type contains the contract values that are in effect for the service agreement. The Tax Exemptions type contains the taxes from which the service agreement is all or partially exempt.",
                "example":"R"
            },
            "billFactor":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "billFactor":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Bill Factor defines the type of contract rider."
                    }
                }
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"Start Date defines the date on which the contract rider becomes effective. The service agreement's start date acts as the default value."
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"End Date defines the date on which the contract rider expires.",
                "example":"2018-02-25"
            },
            "percentExempt":{
                "type":"number",
                "maximum":999.9999,
                "minimum":-999.9999,
                "description":"Percent Exempt defines the customer tax exemption percent. For example, 90 means the customer is 90% exempt and will only pay 10% of the normal tax rate.",
                "example":"0.0000"
            },
            "taxCertification":{
                "type":"string",
                "maxLength":35,
                "description":"Tax Certification defines whether the customer has a tax exemption certificate."
            },
            "taxExemptType":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "taxExemptType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Tax Exempt Type defines the type of exemption."
                    }
                }
            },
            "touGroup":{
                "type":"string",
                "maxLength":30,
                "description":"Indicate the TOU Group that corresponds with the TOU group on the service agreement's TOU Map. Once entered, the collection of TOU codes linked to this TOU group will display."
            },
            "value":{
                "type":"number",
                "maximum":1.0E11,
                "minimum":-1.0E11,
                "description":"Defines the time of use code value."
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version",
                "example":"2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billFactor: object billFactor
• contractTermType: string
  Allowed Values: [ "R ", "T ", "V " ]

  Billing uses Contract Term information when it calculates a bill segment for the service agreement. The Contract Rider type contains the contract riders that are in effect for the service agreement. The Contract Value type contains the contract values that are in effect for the service agreement. The Tax Exemptions type contains the taxes from which the service agreement is all or partially exempt.

  Example: R
• endDate: string (date)
  End Date defines the date on which the contract rider expires.

  Example: 2018-02-25
• percentExempt: number
  Minimum Value: -999.9999

  Maximum Value: 999.9999

  Percent Exempt defines the customer tax exemption percent. For example, 90 means the customer is 90% exempt and will only pay 10% of the normal tax rate.

  Example: 0.0000
• startDate: string (date)
  Start Date defines the date on which the contract rider becomes effective. The service agreement's start date acts as the default value.
• taxCertification: string
  Maximum Length: 35

  Tax Certification defines whether the customer has a tax exemption certificate.
• taxExemptType: object taxExemptType
• touGroup: string
  Maximum Length: 30

  Indicate the TOU Group that corresponds with the TOU group on the service agreement's TOU Map. Once entered, the collection of TOU codes linked to this TOU group will display.
• value: number
  Minimum Value: -1.0E11

  Maximum Value: 1.0E11

  Defines the time of use code value.
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

  Example: 2

{
    "type":"object",
    "properties":{
        "contractTermType":{
            "type":"string",
            "enum":[
                "R   ",
                "T   ",
                "V   "
            ],
            "description":"Billing uses Contract Term information when it calculates a bill segment for the service agreement. The Contract Rider type contains the contract riders that are in effect for the service agreement. The Contract Value type contains the contract values that are in effect for the service agreement. The Tax Exemptions type contains the taxes from which the service agreement is all or partially exempt.",
            "example":"R"
        },
        "billFactor":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "billFactor":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Bill Factor defines the type of contract rider."
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date defines the date on which the contract rider becomes effective. The service agreement's start date acts as the default value."
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date defines the date on which the contract rider expires.",
            "example":"2018-02-25"
        },
        "percentExempt":{
            "type":"number",
            "maximum":999.9999,
            "minimum":-999.9999,
            "description":"Percent Exempt defines the customer tax exemption percent. For example, 90 means the customer is 90% exempt and will only pay 10% of the normal tax rate.",
            "example":"0.0000"
        },
        "taxCertification":{
            "type":"string",
            "maxLength":35,
            "description":"Tax Certification defines whether the customer has a tax exemption certificate."
        },
        "taxExemptType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "taxExemptType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Tax Exempt Type defines the type of exemption."
                }
            }
        },
        "touGroup":{
            "type":"string",
            "maxLength":30,
            "description":"Indicate the TOU Group that corresponds with the TOU group on the service agreement's TOU Map. Once entered, the collection of TOU codes linked to this TOU group will display."
        },
        "value":{
            "type":"number",
            "maximum":1.0E11,
            "minimum":-1.0E11,
            "description":"Defines the time of use code value."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version",
            "example":"2"
        }
    }
}

Nested Schema : billFactor

Type: object

Show Source

• _link: string
  _link
• billFactor: string
  Maximum Length: 8

  Bill Factor defines the type of contract rider.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "billFactor":{
            "type":"string",
            "maxLength":8,
            "description":"Bill Factor defines the type of contract rider."
        }
    }
}

Nested Schema : taxExemptType

Type: object

Show Source

• _link: string
  _link
• taxExemptType: string
  Maximum Length: 8

  Tax Exempt Type defines the type of exemption.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "taxExemptType":{
            "type":"string",
            "maxLength":8,
            "description":"Tax Exempt Type defines the type of exemption."
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date is the date the rate becomes effective. The service agreement's start date acts as the default value.",
                "example":"2018-02-25"
            },
            "rateSchedule":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "rateSchedule":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version",
                "example":"2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• effectiveDate: string (date)
  Effective Date is the date the rate becomes effective. The service agreement's start date acts as the default value.

  Example: 2018-02-25
• rateSchedule: object rateSchedule
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

  Example: 2

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date is the date the rate becomes effective. The service agreement's start date acts as the default value.",
            "example":"2018-02-25"
        },
        "rateSchedule":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "rateSchedule":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version",
            "example":"2"
        }
    }
}

Nested Schema : rateSchedule

Type: object

Show Source

• _link: string
  _link
• rateSchedule: string
  Maximum Length: 8

  Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "rateSchedule":{
            "type":"string",
            "maxLength":8,
            "description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date is the date the charge becomes effective. The service agreement's start date acts as the default value.",
                "example":"2018-02-25"
            },
            "recurringChargeAmount":{
                "type":"number",
                "description":"The Recurring Charge contains effective-dated information that defines the recurring charge amount used to calculate the service agreement's bill segments.",
                "example":"5000"
            },
            "currency":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code defines the currency in which the rate's prices are expressed."
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version",
                "example":"2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• currency: object currency
• effectiveDate: string (date)
  Effective Date is the date the charge becomes effective. The service agreement's start date acts as the default value.

  Example: 2018-02-25
• recurringChargeAmount: number
  The Recurring Charge contains effective-dated information that defines the recurring charge amount used to calculate the service agreement's bill segments.

  Example: 5000
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

  Example: 2

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date is the date the charge becomes effective. The service agreement's start date acts as the default value.",
            "example":"2018-02-25"
        },
        "recurringChargeAmount":{
            "type":"number",
            "description":"The Recurring Charge contains effective-dated information that defines the recurring charge amount used to calculate the service agreement's bill segments.",
            "example":"5000"
        },
        "currency":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code defines the currency in which the rate's prices are expressed."
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version",
            "example":"2"
        }
    }
}

Nested Schema : currency

Type: object

Show Source

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

  Currency Code defines the currency in which the rate's prices are expressed.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code defines the currency in which the rate's prices are expressed."
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "servicePoint":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID is the identifier of the service point."
                    }
                }
            },
            "saSPId":{
                "type":"string",
                "maxLength":10,
                "description":"System assigned record key for the SA/SP relationship."
            },
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Start Date/Time The date and time the service point's consumption starts being billed under the service agreement."
            },
            "startMeterRead":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "startMeterReadId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"ID of the meter reading record at the time the service point was started for the service agreement."
                    }
                }
            },
            "stopDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The date and time the service point's consumption stops being billed under the service agreement."
            },
            "howToUseRead":{
                "type":"string",
                "enum":[
                    "+   ",
                    "-   ",
                    "C   ",
                    "S   ",
                    "X   "
                ],
                "description":"How to Use (SP) indicates how billing uses the consumption associated with the service point. This is not applicable for item-type service points.",
                "example":"S"
            },
            "stopMeterRead":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "stopMeterReadId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Stop Meter Read is the meter read that records the register values as they appeared when the service point was unlinked from the service agreement."
                    }
                }
            },
            "usePercent":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Use Percent indicates the percentage of this service point's consumption that is billed under the service agreement. This field is not applicable for item-type service points.",
                "example":"100"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version",
                "example":"2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• howToUseRead: string
  Allowed Values: [ "+ ", "- ", "C ", "S ", "X " ]

  How to Use (SP) indicates how billing uses the consumption associated with the service point. This is not applicable for item-type service points.

  Example: S
• saSPId: string
  Maximum Length: 10

  System assigned record key for the SA/SP relationship.
• servicePoint: object servicePoint
• startDateTime: string (date-time)
  Start Date/Time The date and time the service point's consumption starts being billed under the service agreement.
• startMeterRead: object startMeterRead
• stopDateTime: string (date-time)
  The date and time the service point's consumption stops being billed under the service agreement.
• stopMeterRead: object stopMeterRead
• usePercent: number
  Minimum Value: -999

  Maximum Value: 999

  Use Percent indicates the percentage of this service point's consumption that is billed under the service agreement. This field is not applicable for item-type service points.

  Example: 100
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

  Example: 2

{
    "type":"object",
    "properties":{
        "servicePoint":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "servicePointId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Point ID is the identifier of the service point."
                }
            }
        },
        "saSPId":{
            "type":"string",
            "maxLength":10,
            "description":"System assigned record key for the SA/SP relationship."
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start Date/Time The date and time the service point's consumption starts being billed under the service agreement."
        },
        "startMeterRead":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "startMeterReadId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"ID of the meter reading record at the time the service point was started for the service agreement."
                }
            }
        },
        "stopDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the service point's consumption stops being billed under the service agreement."
        },
        "howToUseRead":{
            "type":"string",
            "enum":[
                "+   ",
                "-   ",
                "C   ",
                "S   ",
                "X   "
            ],
            "description":"How to Use (SP) indicates how billing uses the consumption associated with the service point. This is not applicable for item-type service points.",
            "example":"S"
        },
        "stopMeterRead":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "stopMeterReadId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Stop Meter Read is the meter read that records the register values as they appeared when the service point was unlinked from the service agreement."
                }
            }
        },
        "usePercent":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Use Percent indicates the percentage of this service point's consumption that is billed under the service agreement. This field is not applicable for item-type service points.",
            "example":"100"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version",
            "example":"2"
        }
    }
}

Nested Schema : servicePoint

Type: object

Show Source

• _link: string
  _link
• servicePointId: string
  Maximum Length: 10

  Service Point ID is the identifier of the service point.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID is the identifier of the service point."
        }
    }
}

Nested Schema : startMeterRead

Type: object

Show Source

• _link: string
  _link
• startMeterReadId: string
  Maximum Length: 12

  ID of the meter reading record at the time the service point was started for the service agreement.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "startMeterReadId":{
            "type":"string",
            "maxLength":12,
            "description":"ID of the meter reading record at the time the service point was started for the service agreement."
        }
    }
}

Nested Schema : stopMeterRead

Type: object

Show Source

• _link: string
  _link
• stopMeterReadId: string
  Maximum Length: 12

  Stop Meter Read is the meter read that records the register values as they appeared when the service point was unlinked from the service agreement.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "stopMeterReadId":{
            "type":"string",
            "maxLength":12,
            "description":"Stop Meter Read is the meter read that records the register values as they appeared when the service point was unlinked from the service agreement."
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "termsAndCondition":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "termsAndCondition":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Terms and Conditions define the type of terms and conditions.",
                        "example":"NGSCC-01"
                    }
                }
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"Start Date defines the date on which the terms and conditions become effective. The service agreement's start date acts as the default value."
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"End Date defines the date on which the terms and conditions expire. This field is only applicable if the terms and conditions expire on an explicit date.",
                "example":"2018-02-25"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version",
                "example":"2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• endDate: string (date)
  End Date defines the date on which the terms and conditions expire. This field is only applicable if the terms and conditions expire on an explicit date.

  Example: 2018-02-25
• startDate: string (date)
  Start Date defines the date on which the terms and conditions become effective. The service agreement's start date acts as the default value.
• termsAndCondition: object termsAndCondition
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

  Example: 2

{
    "type":"object",
    "properties":{
        "termsAndCondition":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "termsAndCondition":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Terms and Conditions define the type of terms and conditions.",
                    "example":"NGSCC-01"
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date defines the date on which the terms and conditions become effective. The service agreement's start date acts as the default value."
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date defines the date on which the terms and conditions expire. This field is only applicable if the terms and conditions expire on an explicit date.",
            "example":"2018-02-25"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version",
            "example":"2"
        }
    }
}

Nested Schema : termsAndCondition

Type: object

Show Source

• _link: string
  _link
• termsAndCondition: string
  Maximum Length: 12

  Terms and Conditions define the type of terms and conditions.

  Example: NGSCC-01

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "termsAndCondition":{
            "type":"string",
            "maxLength":12,
            "description":"Terms and Conditions define the type of terms and conditions.",
            "example":"NGSCC-01"
        }
    }
}

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