Jump to

• Request
• Response

Create Bill Segment

post

https://server:port/spl/rest/apis/customer/financials/billSegments/

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• account: object account
• accountingDate: string (date)
  Accounting Date
• areEstimatesAllowed: boolean
  Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.

  Example: false
• bill: object bill
• billCycle: object billCycle
  Bill Cycle displays the bill cycle and window start date of the bill segment's bill.
• billScenarioId: string
  Maximum Length: 12

  Billing Scenario ID allows you to go to the proposal SA's billing scenario where you can tinker with consumption and the bill segment period used to generate this bill segment.
• billSegmentId: string
  Maximum Length: 12

  Bill Segment ID is the system-assigned unique identifier of the bill segment.

  Example: 211366855400
• billSegmentPeriod: string
  Maximum Length: 30

  Bill Segment Period is the start and end dates of the bill segment.

  Example: 11-04-2013 12-03-2013
• billSegmentStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]

  Bill Segment Status: * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `40 ` - Pending Cancel, * `50 ` - Frozen, * `60 ` - Canceled, * `70 ` - OK
• billSegmentStatusDescription: string
  Maximum Length: 150

  Description for bill segment's status.

  Example: Freezable
• billStatus: string
  Allowed Values: [ "C ", "P " ]

  Bill Status is the bill's status. * `C ` - Complete, * `P ` - Pending

  Example: C
• calcLines: object calcLines
• canActionRegenerate: boolean
  Regenerate action regenerated the bill segment after correcting the cause of the problem for errored bill segment.

  Example: false
• canCancel: boolean
  The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.

  Example: true
• cancelBillSegmentId: string
  Maximum Length: 12

  If the bill segment was canceled and rebilled by another segment, a reference to the new bill segment is displayed. Cancel Bill Segment ID refers to the new bill segment id that superseded the canceled segment.

  Example: 661660087111
• cancelReason: object cancelReason
  Cancel Reason defines why the bill segment(s) are being canceled.
• cancelReasonDescription: string
  Maximum Length: 100

  Cancel Reason Description defines the reason why the bill segment(s) are being canceled.

  Example: Canceled prior to completion.
• canDelete: boolean
  The Delete is used to delete one or more bill segments.

  Example: false
• canFreeze: boolean
  The Freeze is used to freeze one or more bill segments.
• canGenerate: boolean
  The Generate is used to delete and recreate one or more bill segments.

  Example: false
• canInitCancel: boolean
  Initialize Cancel causes the first step of the bill segment cancellation process to be executed. You'd click this button if a frozen bill segment should never have been created (i.e., you want to remove the financial impact of a bill segment from a customer's balance). This button is enabled when you display a Frozen bill segment AND the bill segment's bill is not written off.

  Example: false
• canShowAccountingDate: boolean
  Accounting Date is the date the system uses to determine the financial transaction's accounting period in your general ledger.

  Example: 06-05-2013
• canUndo: boolean
  Undo returns a Pending Cancel bill segment to the Frozen state.

  Example: false
• canUseOldReadsItemsServiceQuantity: boolean
  Check Use Old Read/Item/SQ if the system is configured to use the consumption details used on the original bill segments.

  Example: false
• correctionNote: string
  Maximum Length: 150

  The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.
• creationDateTime: string (date-time)
  Create Date/Time is the date and time on which the bill was originally created.

  Example: 2001-05-16
• creditDate: string (date)
  Bill Date is the business date that was used when the bill was completed.

  Example: 06-05-2013
• creditNote: string
  Maximum Length: 12

  The Credit Note is used to cancel selected bill segments and create a new bill that contains the cancellation details. We refer to this "negative bill" as a credit note.
• currency: object currency
• currentAmount: number
  Current Amount is the bill segment's effect on the service agreement's current balance.

  Example: $405.52
• cutOffDate: string (date)
  Cutoff Date is the last day of the new bill segment.

  Example: 2021-10-05
• exception: object exception
• financialDetails: object financialDetails
• hasBillingOption: boolean
  Billing Option
• hasServiceQuantityOverride: boolean
  SQ Override
• httpMethod: string
  Allowed Values: [ "DELT", "GET ", "POST", "PTCH", "PUT " ]

  HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put

  Example: GET
• isClosingBillSegment: boolean
  If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).

  Example: true
• isCorrectionNote: boolean
  The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.

  Example: false
• isCreditNote: boolean
  Credit Note is used to cancel ALL bill segments and create a new bill that contains the cancellation details.

  Example: false
• isEstimate: boolean
  If the Estimate switch is on, consumption on this bill segment has been estimated by the system.

  Example: true
• isItemOverride: boolean
  Item Override
• items: object items
• masterBillSegmentId: string
  Maximum Length: 12

  Master Bseg ID shows the unique identifier of the master bill segment whose bill triggered the creation of this sub service agreement.

  Example: 661660087111
• messages: object messages
• nextActions: array nextActions
• payoffAmount: number
  Payoff Amount is only shown if it differs from current amount.

  Example: $33.20
• periodEndDate: string (date)
  End Date
• periodStartDate: string (date)
  Start Date
• premise: object premise
• processDate: string (date)
  Process Date
• quote: object quote
• quoteDetailId: string
  Maximum Length: 12

  Quote Detail ID is the system-assigned unique identifier of the quote detail.
• readDetails: object readDetails
• saRelationshipId: string
  Maximum Length: 10

  SA Relationship ID shows the unique identifier of the record that defines the relationship between the sub service agreement and the master service agreement (this record shows the service provider associated with the bill segment).
• serviceAgreement: object serviceAgreement
  SA ID contains information about the bill segment's service agreement.
• serviceQuantities: object serviceQuantities
• shouldRebill: boolean
  The Rebill causes an existing bill segment to be canceled, and a new bill segment to be created.

  Example: true
• specialUsage: string
  Allowed Values: [ "PROP" ]

  Special Usage flag shows if it's a proposal SA. * `PROP` - Proposal SA

  Example: PROP
• statusChangeDateTime: string (date-time)
  Bill Segment's status change date/time

  Example: 06-05-2013 04:28PM
• subBillSegments: object subBillSegments
• usageEndDateTime: string (date-time)
  Usage end date is the last date for bill segment used by meter data management system.

  Example: 03-04-2013
• usagePeriod: string
  Maximum Length: 1

  Usage Period is the period used by the meter data management system to determine the correct interval data to process for the bill segment.

  Example: 11-04-2013 12-03-2013
• usageStartDateTime: string (date-time)
  Usage start date is the first day for bill segment used by meter data management system.

  Example: 03-04-2013
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version
• windowStartDate: string (date)
  Window Start Date

  Example: 12-03-2013

{
    "type":"object",
    "properties":{
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put",
            "example":"GET"
        },
        "billSegmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.",
            "example":"211366855400"
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID identifies the customer who is responsible for the bill.",
                    "example":"1112345900"
                }
            }
        },
        "currentAmount":{
            "type":"number",
            "description":"Current Amount is the bill segment's effect on the service agreement's current balance.",
            "example":"$405.52"
        },
        "payoffAmount":{
            "type":"number",
            "description":"Payoff Amount is only shown if it differs from current amount.",
            "example":"$33.20"
        },
        "bill":{
            "type":"object",
            "properties":{
                "billId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
                    "example":"211122345678"
                }
            }
        },
        "serviceAgreement":{
            "type":"object",
            "description":"SA ID contains information about the bill segment's service agreement.",
            "properties":{
                "serviceAgreement":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                }
            }
        },
        "periodStartDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date"
        },
        "periodEndDate":{
            "type":"string",
            "format":"date",
            "description":"End Date"
        },
        "usageStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Usage start date is the first day for bill segment used by meter data management system.",
            "example":"03-04-2013"
        },
        "usageEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Usage end date is the last date for bill segment used by meter data management system.",
            "example":"03-04-2013"
        },
        "billSegmentPeriod":{
            "type":"string",
            "maxLength":30,
            "description":"Bill Segment Period is the start and end dates of the bill segment.",
            "example":"11-04-2013 12-03-2013"
        },
        "usagePeriod":{
            "type":"string",
            "maxLength":1,
            "description":"Usage Period is the period used by the meter data management system to determine the correct interval data to process for the bill segment.",
            "example":"11-04-2013 12-03-2013"
        },
        "billCycle":{
            "type":"object",
            "description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.",
            "properties":{
                "billCycle":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.",
                    "example":"M-D2 (Monthly bill cycle - day 2)"
                }
            }
        },
        "billStatus":{
            "type":"string",
            "enum":[
                "C   ",
                "P   "
            ],
            "description":"Bill Status is the bill's status.\n* `C   ` - Complete,\n* `P   ` - Pending",
            "example":"C"
        },
        "isEstimate":{
            "type":"boolean",
            "description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.",
            "example":"true"
        },
        "isClosingBillSegment":{
            "type":"boolean",
            "description":"If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).",
            "example":"true"
        },
        "hasServiceQuantityOverride":{
            "type":"boolean",
            "description":"SQ Override"
        },
        "isItemOverride":{
            "type":"boolean",
            "description":"Item Override"
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."
                }
            }
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time is the date and time on which the bill was originally created.",
            "example":"2001-05-16"
        },
        "saRelationshipId":{
            "type":"string",
            "maxLength":10,
            "description":"SA Relationship ID shows the unique identifier of the record that defines the relationship between the sub service agreement and the master service agreement (this record shows the service provider associated with the bill segment)."
        },
        "billSegmentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
        },
        "billSegmentStatusDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Description for bill segment's status.",
            "example":"Freezable"
        },
        "statusChangeDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Bill Segment's status change date/time",
            "example":"06-05-2013 04:28PM"
        },
        "cancelReasonDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Cancel Reason Description defines the reason why the bill segment(s) are being canceled.",
            "example":"Canceled prior to completion."
        },
        "quote":{
            "type":"object",
            "properties":{
                "quoteId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Quote ID is the system-assigned unique identifier of the quote."
                }
            }
        },
        "cutOffDate":{
            "type":"string",
            "format":"date",
            "description":"Cutoff Date is the last day of the new bill segment.",
            "example":"2021-10-05"
        },
        "accountingDate":{
            "type":"string",
            "format":"date",
            "description":"Accounting Date"
        },
        "cancelReason":{
            "type":"object",
            "description":"Cancel Reason defines why the bill segment(s) are being canceled.",
            "properties":{
                "cancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Cancel Reason defines why the bill segment(s) are being canceled.",
                    "example":"Wrong read"
                }
            }
        },
        "areEstimatesAllowed":{
            "type":"boolean",
            "description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.",
            "example":"false"
        },
        "hasBillingOption":{
            "type":"boolean",
            "description":"Billing Option"
        },
        "canUseOldReadsItemsServiceQuantity":{
            "type":"boolean",
            "description":"Check Use Old Read/Item/SQ if the system is configured to use the consumption details used on the original bill segments.",
            "example":"false"
        },
        "creditDate":{
            "type":"string",
            "format":"date",
            "description":"Bill Date is the business date that was used when the bill was completed.",
            "example":"06-05-2013"
        },
        "creditNote":{
            "type":"string",
            "maxLength":12,
            "description":"The Credit Note is used to cancel selected bill segments and create a new bill that contains the cancellation details. We refer to this \"negative bill\" as a credit note."
        },
        "correctionNote":{
            "type":"string",
            "maxLength":150,
            "description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details."
        },
        "canShowAccountingDate":{
            "type":"boolean",
            "description":"Accounting Date  is the date the system uses to determine the financial transaction's accounting period in your general ledger.",
            "example":"06-05-2013"
        },
        "processDate":{
            "type":"string",
            "format":"date",
            "description":"Process Date"
        },
        "specialUsage":{
            "type":"string",
            "enum":[
                "PROP"
            ],
            "description":"Special Usage flag shows if it's a proposal SA.\n* `PROP` - Proposal SA",
            "example":"PROP"
        },
        "currency":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code"
                }
            }
        },
        "windowStartDate":{
            "type":"string",
            "format":"date",
            "description":"Window Start Date",
            "example":"12-03-2013"
        },
        "cancelBillSegmentId":{
            "type":"string",
            "maxLength":12,
            "description":"If the bill segment was canceled and rebilled by another segment, a reference to the new bill segment is displayed. Cancel Bill Segment ID refers to the new bill segment id that superseded the canceled segment.",
            "example":"661660087111"
        },
        "masterBillSegmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Master Bseg ID shows the unique identifier of the master bill segment whose bill triggered the creation of this sub service agreement.",
            "example":"661660087111"
        },
        "quoteDetailId":{
            "type":"string",
            "maxLength":12,
            "description":"Quote Detail ID is the system-assigned unique identifier of the quote detail."
        },
        "billScenarioId":{
            "type":"string",
            "maxLength":12,
            "description":"Billing Scenario ID allows you to go to the proposal SA's billing scenario where you can tinker with consumption and the bill segment period used to generate this bill segment."
        },
        "canCancel":{
            "type":"boolean",
            "description":"The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.",
            "example":"true"
        },
        "canDelete":{
            "type":"boolean",
            "description":"The Delete is used to delete one or more bill segments.",
            "example":"false"
        },
        "canFreeze":{
            "type":"boolean",
            "description":"The Freeze is used to freeze one or more bill segments."
        },
        "canGenerate":{
            "type":"boolean",
            "description":"The Generate is used to delete and recreate one or more bill segments.",
            "example":"false"
        },
        "canInitCancel":{
            "type":"boolean",
            "description":"Initialize  Cancel causes the first step of the bill segment cancellation process to be executed. You'd click this button if a frozen bill segment should never have been created (i.e., you want to remove the financial impact of a bill segment from a customer's balance).\n\nThis button is enabled when you display a Frozen bill segment AND the bill segment's bill is not written off.",
            "example":"false"
        },
        "shouldRebill":{
            "type":"boolean",
            "description":"The Rebill causes an existing bill segment to be canceled, and a new bill segment to be created.",
            "example":"true"
        },
        "canActionRegenerate":{
            "type":"boolean",
            "description":"Regenerate action regenerated the bill segment after correcting the cause of the problem for errored bill segment.",
            "example":"false"
        },
        "canUndo":{
            "type":"boolean",
            "description":"Undo returns a Pending Cancel bill segment to the Frozen state.",
            "example":"false"
        },
        "isCreditNote":{
            "type":"boolean",
            "description":"Credit Note is used to cancel ALL bill segments and create a new bill that contains the cancellation details.",
            "example":"false"
        },
        "isCorrectionNote":{
            "type":"boolean",
            "description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.",
            "example":"false"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "exception":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message category within Oracle Utilities Application Framework.",
                    "example":"0"
                },
                "messageNumber":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message number within Oracle Utilities Application Framework.",
                    "example":"0"
                },
                "expandedMessage":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Expanded Message exception"
                }
            }
        },
        "readDetails":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "finalUnitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.",
                                "example":"CF"
                            },
                            "finalTimeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Final Time of Use is the final time-of-use code of the calculation / audit read.",
                                "example":"ON"
                            },
                            "finalServiceQuantityId":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Final SQI is the final service quantity identifier of the calculation / audit read.",
                                "example":"DAMT"
                            },
                            "registerQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.",
                                "example":"200.000000"
                            },
                            "servicePointId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID"
                            },
                            "meterConfigurationId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Meter Configuration ID"
                            },
                            "sequence":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Sequence"
                            },
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "timeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            },
                            "serviceQuantityIdentifier":{
                                "type":"string",
                                "maxLength":30,
                                "description":"SQI"
                            },
                            "startRegisterReading":{
                                "type":"number",
                                "maximum":9.99999999999999E8,
                                "minimum":-9.99999999999999E8,
                                "description":"Start Register Reading is the start register reading.",
                                "example":"7201.000000"
                            },
                            "endRegisterReading":{
                                "type":"number",
                                "maximum":9.99999999999999E8,
                                "minimum":-9.99999999999999E8,
                                "description":"End Register Reading is the end register reading.",
                                "example":"11578.000000"
                            },
                            "measuredQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive",
                                "example":"4377.000000"
                            },
                            "registerConstant":{
                                "type":"number",
                                "maximum":999999.999999,
                                "minimum":-999999.999999,
                                "description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.",
                                "example":"1.000000"
                            },
                            "howToUse":{
                                "type":"string",
                                "enum":[
                                    "+   ",
                                    "-   ",
                                    "C   ",
                                    "P   "
                                ],
                                "description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak",
                                "example":"+"
                            },
                            "howToUseRead":{
                                "type":"string",
                                "enum":[
                                    "+   ",
                                    "-   ",
                                    "C   ",
                                    "S   ",
                                    "X   "
                                ],
                                "description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit",
                                "example":"+"
                            },
                            "usePercent":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Use Percent is the percentage of the total consumption that was billed.",
                                "example":"100"
                            },
                            "measuresPeakQuantity":{
                                "type":"boolean",
                                "description":"Measures Peak Qty"
                            },
                            "startReadDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Start Read Date/Time is the date and time of the start meter read.",
                                "example":"1998-06-30T00:00:00-04:00"
                            },
                            "endReadDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"End Read Date/Time is the date and time of the end meter read.",
                                "example":"998-09-30T00:00:00-04:00"
                            },
                            "startRegisterReadId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Start Register Read ID is the unique identifier of the start register read.",
                                "example":"444074862768"
                            },
                            "endRegisterReadingId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"End Register Read ID is the unique identifier of the end register read.",
                                "example":"444074849655"
                            },
                            "startRegisterReadTypeDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Start Register Read Type Description"
                            },
                            "endRegisterReadTypeDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"End Register Read Type Description"
                            },
                            "multiplier":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
                                "example":"1.000000"
                            },
                            "consumptionType":{
                                "type":"string",
                                "enum":[
                                    "C   ",
                                    "S   "
                                ],
                                "description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive",
                                "example":"S"
                            },
                            "notAvailableConsumptionDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Not Available Consumption Description"
                            },
                            "startMeterRead":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Start meter read ID",
                                "example":"444074813104"
                            },
                            "endMeterRead":{
                                "type":"string",
                                "maxLength":12,
                                "description":"End meter read ID",
                                "example":"44074866808"
                            },
                            "meterReadId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Meter Read ID",
                                "example":"8833057699"
                            },
                            "unitOfMeasure2":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "serviceQuantityIdentifier2":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Service Quantity Identifier"
                            },
                            "timeOfUse2":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            },
                            "finalUomDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Final Uom Description"
                            },
                            "finalSqiDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Final SQI Description"
                            },
                            "finalTouDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Final TOU Description"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "items":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Sequence"
                            },
                            "itemType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Item Type is the type of item.",
                                "example":"Generic Current Transformer"
                            },
                            "item":{
                                "type":"object",
                                "properties":{
                                    "item":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Item ID"
                                    }
                                }
                            },
                            "startDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Start Date"
                            },
                            "endDate":{
                                "type":"string",
                                "format":"date",
                                "description":"End Date"
                            },
                            "itemCount":{
                                "type":"number",
                                "maximum":9.9999999999E8,
                                "minimum":-9.9999999999E8,
                                "description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.",
                                "example":"1.00"
                            },
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "dailyServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Daily Service Quantity is the item's estimated amount of daily consumption.",
                                "example":"470.762600"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "serviceQuantities":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "timeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            },
                            "serviceQuantityIdentifier":{
                                "type":"string",
                                "maxLength":30,
                                "description":"SQI"
                            },
                            "initialServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
                                "example":"470.762600"
                            },
                            "billableServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Billable Service Quantity"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "calcLines":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "headerSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Header Sequence"
                            },
                            "startDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Start Date"
                            },
                            "endDate":{
                                "type":"string",
                                "format":"date",
                                "description":"End Date"
                            },
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code"
                            },
                            "calculatedAmount":{
                                "type":"number",
                                "description":"Calculated Amount"
                            },
                            "rateSchedule":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Rate Schedule"
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "billableCharge":{
                                "type":"object",
                                "properties":{
                                    "billableChargeId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Billable Charge ID"
                                    }
                                }
                            },
                            "descriptionOnBill":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Description on Bill"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "calculationLines":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "headerSequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Header Sequence"
                                                },
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Sequence"
                                                },
                                                "characteristicType":{
                                                    "type":"object",
                                                    "properties":{
                                                        "characteristicType":{
                                                            "type":"string",
                                                            "maxLength":8,
                                                            "description":"Characteristic Type"
                                                        }
                                                    }
                                                },
                                                "currency":{
                                                    "type":"string",
                                                    "maxLength":3,
                                                    "description":"Currency Code"
                                                },
                                                "characteristicValue":{
                                                    "type":"string",
                                                    "maxLength":16,
                                                    "description":"Characteristic Value"
                                                },
                                                "distributionCode":{
                                                    "type":"object",
                                                    "properties":{
                                                        "distributionCode":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Distribution Code"
                                                        }
                                                    }
                                                },
                                                "unitOfMeasure":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Unit of Measure"
                                                },
                                                "timeOfUse":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Time of Use"
                                                },
                                                "rcSequence":{
                                                    "type":"number",
                                                    "maximum":9999,
                                                    "minimum":-9999,
                                                    "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                                                    "example":"10"
                                                },
                                                "shouldPrint":{
                                                    "type":"boolean",
                                                    "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                                    "example":"true"
                                                },
                                                "shouldAppearInSummary":{
                                                    "type":"boolean",
                                                    "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                                    "example":"true"
                                                },
                                                "calculatedAmount":{
                                                    "type":"number",
                                                    "description":"Calculated Amount"
                                                },
                                                "exemptAmount":{
                                                    "type":"number",
                                                    "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                                                    "example":"$0.00"
                                                },
                                                "baseAmount":{
                                                    "type":"number",
                                                    "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                                                    "example":"$102.71"
                                                },
                                                "serviceQuantityIdentifier":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"SQI"
                                                },
                                                "billableServiceQuantity":{
                                                    "type":"number",
                                                    "maximum":1.0E12,
                                                    "minimum":-1.0E12,
                                                    "description":"Billable Service Quantity"
                                                },
                                                "measuresPeakQuantity":{
                                                    "type":"boolean",
                                                    "description":"Measures Peak Qty"
                                                },
                                                "descriptionOnBill":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Description on Bill"
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                },
                                                "distributionDescription":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Distribution Code Description"
                                                },
                                                "isCharacteristicExist":{
                                                    "type":"boolean",
                                                    "description":"Characteristic exists",
                                                    "example":"false"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "financialDetails":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "financialTransactionId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).",
                                "example":"211166656266"
                            },
                            "financialTransactionType":{
                                "type":"string",
                                "enum":[
                                    "AD  ",
                                    "AX  ",
                                    "BS  ",
                                    "BX  ",
                                    "PS  ",
                                    "PX  "
                                ],
                                "description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation",
                                "example":"BS"
                            },
                            "financialTransactionTypeDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"FT Type Description"
                            },
                            "currentAmount":{
                                "type":"number",
                                "description":"Current Amount"
                            },
                            "accountingDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Accounting Date"
                            },
                            "arrearsDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Arrears Date is the date the FT starts aging.",
                                "example":"03-04-2013"
                            },
                            "shouldShowOnBill":{
                                "type":"boolean",
                                "description":"Show on bill indicates if information about the FT appears on the customer's bill.",
                                "example":"true"
                            },
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Sequence"
                                        },
                                        "distributionCode":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Distribution Code"
                                        },
                                        "characteristicType":{
                                            "type":"string",
                                            "maxLength":8,
                                            "description":"Characteristic Type"
                                        },
                                        "characteristicValue":{
                                            "type":"string",
                                            "maxLength":16,
                                            "description":"Characteristic Value"
                                        },
                                        "amount":{
                                            "type":"number",
                                            "description":"Amount defines the journal line's amount.",
                                            "example":"$33.00"
                                        },
                                        "statistics":{
                                            "type":"string",
                                            "maxLength":8,
                                            "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                                            "example":"CF"
                                        },
                                        "statisticAmount":{
                                            "type":"number",
                                            "maximum":1.0E13,
                                            "minimum":-1.0E13,
                                            "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                                            "example":"0.000"
                                        },
                                        "isTotalAmount":{
                                            "type":"boolean",
                                            "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                                            "example":"true"
                                        },
                                        "distributionDescription":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Distribution Code Description"
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "subBillSegments":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "currentAmount":{
                                "type":"number",
                                "description":"Current Amount"
                            },
                            "billSegmentStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "40  ",
                                    "50  ",
                                    "60  ",
                                    "70  "
                                ],
                                "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
                            }
                        }
                    }
                }
            }
        },
        "messages":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "billMessageCode":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Bill Message"
                            },
                            "insert":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Insert Code defines if the bill message causes an insert in the envelope."
                            },
                            "messagePriority":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "40  ",
                                    "50  ",
                                    "60  ",
                                    "70  ",
                                    "80  ",
                                    "90  "
                                ],
                                "description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest",
                                "example":"20"
                            },
                            "messageOnBill":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Message On Bill is the message associated with the code.",
                                "example":"Electric service not billed"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "nextActions":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "action":{
                        "type":"string",
                        "enum":[
                            "C1CF",
                            "C1CO",
                            "C1CR",
                            "C1DE",
                            "C1FR",
                            "C1GN",
                            "C1RO"
                        ],
                        "description":"Bill Web Service Actions:\n* `C1CF` - Cancel Frozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-BillSegm"
    }
}

Nested Schema : account

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID identifies the customer who is responsible for the bill.

  Example: 1112345900

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID identifies the customer who is responsible for the bill.",
            "example":"1112345900"
        }
    }
}

Nested Schema : bill

Type: object

Show Source

• billId: string
  Maximum Length: 12

  Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.

  Example: 211122345678

{
    "type":"object",
    "properties":{
        "billId":{
            "type":"string",
            "maxLength":12,
            "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
            "example":"211122345678"
        }
    }
}

Nested Schema : billCycle

Type: object

Bill Cycle displays the bill cycle and window start date of the bill segment's bill.

Show Source

• billCycle: string
  Maximum Length: 4

  Bill Cycle displays the bill cycle and window start date of the bill segment's bill.

  Example: M-D2 (Monthly bill cycle - day 2)

{
    "type":"object",
    "description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.",
    "properties":{
        "billCycle":{
            "type":"string",
            "maxLength":4,
            "description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.",
            "example":"M-D2 (Monthly bill cycle - day 2)"
        }
    }
}

Nested Schema : calcLines

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "headerSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Header Sequence"
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Start Date"
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"End Date"
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code"
                    },
                    "calculatedAmount":{
                        "type":"number",
                        "description":"Calculated Amount"
                    },
                    "rateSchedule":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Rate Schedule"
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "billableCharge":{
                        "type":"object",
                        "properties":{
                            "billableChargeId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Billable Charge ID"
                            }
                        }
                    },
                    "descriptionOnBill":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Description on Bill"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "calculationLines":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "headerSequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Header Sequence"
                                        },
                                        "sequence":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Sequence"
                                        },
                                        "characteristicType":{
                                            "type":"object",
                                            "properties":{
                                                "characteristicType":{
                                                    "type":"string",
                                                    "maxLength":8,
                                                    "description":"Characteristic Type"
                                                }
                                            }
                                        },
                                        "currency":{
                                            "type":"string",
                                            "maxLength":3,
                                            "description":"Currency Code"
                                        },
                                        "characteristicValue":{
                                            "type":"string",
                                            "maxLength":16,
                                            "description":"Characteristic Value"
                                        },
                                        "distributionCode":{
                                            "type":"object",
                                            "properties":{
                                                "distributionCode":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Distribution Code"
                                                }
                                            }
                                        },
                                        "unitOfMeasure":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Unit of Measure"
                                        },
                                        "timeOfUse":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Time of Use"
                                        },
                                        "rcSequence":{
                                            "type":"number",
                                            "maximum":9999,
                                            "minimum":-9999,
                                            "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                                            "example":"10"
                                        },
                                        "shouldPrint":{
                                            "type":"boolean",
                                            "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                            "example":"true"
                                        },
                                        "shouldAppearInSummary":{
                                            "type":"boolean",
                                            "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                            "example":"true"
                                        },
                                        "calculatedAmount":{
                                            "type":"number",
                                            "description":"Calculated Amount"
                                        },
                                        "exemptAmount":{
                                            "type":"number",
                                            "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                                            "example":"$0.00"
                                        },
                                        "baseAmount":{
                                            "type":"number",
                                            "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                                            "example":"$102.71"
                                        },
                                        "serviceQuantityIdentifier":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"SQI"
                                        },
                                        "billableServiceQuantity":{
                                            "type":"number",
                                            "maximum":1.0E12,
                                            "minimum":-1.0E12,
                                            "description":"Billable Service Quantity"
                                        },
                                        "measuresPeakQuantity":{
                                            "type":"boolean",
                                            "description":"Measures Peak Qty"
                                        },
                                        "descriptionOnBill":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Description on Bill"
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        },
                                        "distributionDescription":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Distribution Code Description"
                                        },
                                        "isCharacteristicExist":{
                                            "type":"boolean",
                                            "description":"Characteristic exists",
                                            "example":"false"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : cancelReason

Type: object

Cancel Reason defines why the bill segment(s) are being canceled.

Show Source

• cancelReason: string
  Maximum Length: 4

  Cancel Reason defines why the bill segment(s) are being canceled.

  Example: Wrong read

{
    "type":"object",
    "description":"Cancel Reason defines why the bill segment(s) are being canceled.",
    "properties":{
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason defines why the bill segment(s) are being canceled.",
            "example":"Wrong read"
        }
    }
}

Nested Schema : currency

Type: object

Show Source

• currency: string
  Maximum Length: 3

  Currency Code

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

Nested Schema : exception

Type: object

Show Source

• expandedMessage: string
  Maximum Length: 254

  Expanded Message exception
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message category within Oracle Utilities Application Framework.

  Example: 0
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message number within Oracle Utilities Application Framework.

  Example: 0

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message category within Oracle Utilities Application Framework.",
            "example":"0"
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message number within Oracle Utilities Application Framework.",
            "example":"0"
        },
        "expandedMessage":{
            "type":"string",
            "maxLength":254,
            "description":"Expanded Message exception"
        }
    }
}

Nested Schema : financialDetails

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "financialTransactionId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).",
                        "example":"211166656266"
                    },
                    "financialTransactionType":{
                        "type":"string",
                        "enum":[
                            "AD  ",
                            "AX  ",
                            "BS  ",
                            "BX  ",
                            "PS  ",
                            "PX  "
                        ],
                        "description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation",
                        "example":"BS"
                    },
                    "financialTransactionTypeDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"FT Type Description"
                    },
                    "currentAmount":{
                        "type":"number",
                        "description":"Current Amount"
                    },
                    "accountingDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Accounting Date"
                    },
                    "arrearsDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Arrears Date is the date the FT starts aging.",
                        "example":"03-04-2013"
                    },
                    "shouldShowOnBill":{
                        "type":"boolean",
                        "description":"Show on bill indicates if information about the FT appears on the customer's bill.",
                        "example":"true"
                    },
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence"
                                },
                                "distributionCode":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Distribution Code"
                                },
                                "characteristicType":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"Characteristic Type"
                                },
                                "characteristicValue":{
                                    "type":"string",
                                    "maxLength":16,
                                    "description":"Characteristic Value"
                                },
                                "amount":{
                                    "type":"number",
                                    "description":"Amount defines the journal line's amount.",
                                    "example":"$33.00"
                                },
                                "statistics":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                                    "example":"CF"
                                },
                                "statisticAmount":{
                                    "type":"number",
                                    "maximum":1.0E13,
                                    "minimum":-1.0E13,
                                    "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                                    "example":"0.000"
                                },
                                "isTotalAmount":{
                                    "type":"boolean",
                                    "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                                    "example":"true"
                                },
                                "distributionDescription":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Distribution Code Description"
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Sequence"
                    },
                    "itemType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Item Type is the type of item.",
                        "example":"Generic Current Transformer"
                    },
                    "item":{
                        "type":"object",
                        "properties":{
                            "item":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Item ID"
                            }
                        }
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Start Date"
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"End Date"
                    },
                    "itemCount":{
                        "type":"number",
                        "maximum":9.9999999999E8,
                        "minimum":-9.9999999999E8,
                        "description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.",
                        "example":"1.00"
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "dailyServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Daily Service Quantity is the item's estimated amount of daily consumption.",
                        "example":"470.762600"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : messages

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "billMessageCode":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Bill Message"
                    },
                    "insert":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Insert Code defines if the bill message causes an insert in the envelope."
                    },
                    "messagePriority":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  ",
                            "50  ",
                            "60  ",
                            "70  ",
                            "80  ",
                            "90  "
                        ],
                        "description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest",
                        "example":"20"
                    },
                    "messageOnBill":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Message On Bill is the message associated with the code.",
                        "example":"Electric service not billed"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : nextActions

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "action":{
                "type":"string",
                "enum":[
                    "C1CF",
                    "C1CO",
                    "C1CR",
                    "C1DE",
                    "C1FR",
                    "C1GN",
                    "C1RO"
                ],
                "description":"Bill Web Service Actions:\n* `C1CF` - Cancel Frozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen"
            }
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• premiseId: string
  Maximum Length: 10

  Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise.

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."
        }
    }
}

Nested Schema : quote

Type: object

Show Source

• quoteId: string
  Maximum Length: 12

  Quote ID is the system-assigned unique identifier of the quote.

{
    "type":"object",
    "properties":{
        "quoteId":{
            "type":"string",
            "maxLength":12,
            "description":"Quote ID is the system-assigned unique identifier of the quote."
        }
    }
}

Nested Schema : readDetails

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "finalUnitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.",
                        "example":"CF"
                    },
                    "finalTimeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Final Time of Use is the final time-of-use code of the calculation / audit read.",
                        "example":"ON"
                    },
                    "finalServiceQuantityId":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Final SQI is the final service quantity identifier of the calculation / audit read.",
                        "example":"DAMT"
                    },
                    "registerQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.",
                        "example":"200.000000"
                    },
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID"
                    },
                    "meterConfigurationId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Meter Configuration ID"
                    },
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Sequence"
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "serviceQuantityIdentifier":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI"
                    },
                    "startRegisterReading":{
                        "type":"number",
                        "maximum":9.99999999999999E8,
                        "minimum":-9.99999999999999E8,
                        "description":"Start Register Reading is the start register reading.",
                        "example":"7201.000000"
                    },
                    "endRegisterReading":{
                        "type":"number",
                        "maximum":9.99999999999999E8,
                        "minimum":-9.99999999999999E8,
                        "description":"End Register Reading is the end register reading.",
                        "example":"11578.000000"
                    },
                    "measuredQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive",
                        "example":"4377.000000"
                    },
                    "registerConstant":{
                        "type":"number",
                        "maximum":999999.999999,
                        "minimum":-999999.999999,
                        "description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.",
                        "example":"1.000000"
                    },
                    "howToUse":{
                        "type":"string",
                        "enum":[
                            "+   ",
                            "-   ",
                            "C   ",
                            "P   "
                        ],
                        "description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak",
                        "example":"+"
                    },
                    "howToUseRead":{
                        "type":"string",
                        "enum":[
                            "+   ",
                            "-   ",
                            "C   ",
                            "S   ",
                            "X   "
                        ],
                        "description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit",
                        "example":"+"
                    },
                    "usePercent":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Use Percent is the percentage of the total consumption that was billed.",
                        "example":"100"
                    },
                    "measuresPeakQuantity":{
                        "type":"boolean",
                        "description":"Measures Peak Qty"
                    },
                    "startReadDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Start Read Date/Time is the date and time of the start meter read.",
                        "example":"1998-06-30T00:00:00-04:00"
                    },
                    "endReadDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"End Read Date/Time is the date and time of the end meter read.",
                        "example":"998-09-30T00:00:00-04:00"
                    },
                    "startRegisterReadId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Start Register Read ID is the unique identifier of the start register read.",
                        "example":"444074862768"
                    },
                    "endRegisterReadingId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"End Register Read ID is the unique identifier of the end register read.",
                        "example":"444074849655"
                    },
                    "startRegisterReadTypeDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Start Register Read Type Description"
                    },
                    "endRegisterReadTypeDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"End Register Read Type Description"
                    },
                    "multiplier":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
                        "example":"1.000000"
                    },
                    "consumptionType":{
                        "type":"string",
                        "enum":[
                            "C   ",
                            "S   "
                        ],
                        "description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive",
                        "example":"S"
                    },
                    "notAvailableConsumptionDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Not Available Consumption Description"
                    },
                    "startMeterRead":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Start meter read ID",
                        "example":"444074813104"
                    },
                    "endMeterRead":{
                        "type":"string",
                        "maxLength":12,
                        "description":"End meter read ID",
                        "example":"44074866808"
                    },
                    "meterReadId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Meter Read ID",
                        "example":"8833057699"
                    },
                    "unitOfMeasure2":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "serviceQuantityIdentifier2":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service Quantity Identifier"
                    },
                    "timeOfUse2":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "finalUomDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Final Uom Description"
                    },
                    "finalSqiDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Final SQI Description"
                    },
                    "finalTouDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Final TOU Description"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : serviceAgreement

Type: object

SA ID contains information about the bill segment's service agreement.

Show Source

• serviceAgreement: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "description":"SA ID contains information about the bill segment's service agreement.",
    "properties":{
        "serviceAgreement":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

Nested Schema : serviceQuantities

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "serviceQuantityIdentifier":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI"
                    },
                    "initialServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
                        "example":"470.762600"
                    },
                    "billableServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Billable Service Quantity"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : subBillSegments

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "currentAmount":{
                        "type":"number",
                        "description":"Current Amount"
                    },
                    "billSegmentStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  ",
                            "50  ",
                            "60  ",
                            "70  "
                        ],
                        "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "headerSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Header Sequence"
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"Start Date"
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"End Date"
            },
            "currency":{
                "type":"string",
                "maxLength":3,
                "description":"Currency Code"
            },
            "calculatedAmount":{
                "type":"number",
                "description":"Calculated Amount"
            },
            "rateSchedule":{
                "type":"string",
                "maxLength":8,
                "description":"Rate Schedule"
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "billableCharge":{
                "type":"object",
                "properties":{
                    "billableChargeId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Billable Charge ID"
                    }
                }
            },
            "descriptionOnBill":{
                "type":"string",
                "maxLength":254,
                "description":"Description on Bill"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "calculationLines":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "headerSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Header Sequence"
                                },
                                "sequence":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Sequence"
                                },
                                "characteristicType":{
                                    "type":"object",
                                    "properties":{
                                        "characteristicType":{
                                            "type":"string",
                                            "maxLength":8,
                                            "description":"Characteristic Type"
                                        }
                                    }
                                },
                                "currency":{
                                    "type":"string",
                                    "maxLength":3,
                                    "description":"Currency Code"
                                },
                                "characteristicValue":{
                                    "type":"string",
                                    "maxLength":16,
                                    "description":"Characteristic Value"
                                },
                                "distributionCode":{
                                    "type":"object",
                                    "properties":{
                                        "distributionCode":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Distribution Code"
                                        }
                                    }
                                },
                                "unitOfMeasure":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Unit of Measure"
                                },
                                "timeOfUse":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Time of Use"
                                },
                                "rcSequence":{
                                    "type":"number",
                                    "maximum":9999,
                                    "minimum":-9999,
                                    "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                                    "example":"10"
                                },
                                "shouldPrint":{
                                    "type":"boolean",
                                    "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                    "example":"true"
                                },
                                "shouldAppearInSummary":{
                                    "type":"boolean",
                                    "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                    "example":"true"
                                },
                                "calculatedAmount":{
                                    "type":"number",
                                    "description":"Calculated Amount"
                                },
                                "exemptAmount":{
                                    "type":"number",
                                    "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                                    "example":"$0.00"
                                },
                                "baseAmount":{
                                    "type":"number",
                                    "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                                    "example":"$102.71"
                                },
                                "serviceQuantityIdentifier":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"SQI"
                                },
                                "billableServiceQuantity":{
                                    "type":"number",
                                    "maximum":1.0E12,
                                    "minimum":-1.0E12,
                                    "description":"Billable Service Quantity"
                                },
                                "measuresPeakQuantity":{
                                    "type":"boolean",
                                    "description":"Measures Peak Qty"
                                },
                                "descriptionOnBill":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Description on Bill"
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                },
                                "distributionDescription":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Distribution Code Description"
                                },
                                "isCharacteristicExist":{
                                    "type":"boolean",
                                    "description":"Characteristic exists",
                                    "example":"false"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billableCharge: object billableCharge
• calculatedAmount: number
  Calculated Amount
• calculationLines: object calculationLines
• currency: string
  Maximum Length: 3

  Currency Code
• descriptionOnBill: string
  Maximum Length: 254

  Description on Bill
• effectiveDate: string (date)
  Effective Date
• endDate: string (date)
  End Date
• headerSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Header Sequence
• rateSchedule: string
  Maximum Length: 8

  Rate Schedule
• startDate: string (date)
  Start Date
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "headerSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Header Sequence"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date"
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "calculatedAmount":{
            "type":"number",
            "description":"Calculated Amount"
        },
        "rateSchedule":{
            "type":"string",
            "maxLength":8,
            "description":"Rate Schedule"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "billableCharge":{
            "type":"object",
            "properties":{
                "billableChargeId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Billable Charge ID"
                }
            }
        },
        "descriptionOnBill":{
            "type":"string",
            "maxLength":254,
            "description":"Description on Bill"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "calculationLines":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "headerSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Header Sequence"
                            },
                            "sequence":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Sequence"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code"
                            },
                            "characteristicValue":{
                                "type":"string",
                                "maxLength":16,
                                "description":"Characteristic Value"
                            },
                            "distributionCode":{
                                "type":"object",
                                "properties":{
                                    "distributionCode":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Distribution Code"
                                    }
                                }
                            },
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "timeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            },
                            "rcSequence":{
                                "type":"number",
                                "maximum":9999,
                                "minimum":-9999,
                                "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                                "example":"10"
                            },
                            "shouldPrint":{
                                "type":"boolean",
                                "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                "example":"true"
                            },
                            "shouldAppearInSummary":{
                                "type":"boolean",
                                "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                "example":"true"
                            },
                            "calculatedAmount":{
                                "type":"number",
                                "description":"Calculated Amount"
                            },
                            "exemptAmount":{
                                "type":"number",
                                "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                                "example":"$0.00"
                            },
                            "baseAmount":{
                                "type":"number",
                                "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                                "example":"$102.71"
                            },
                            "serviceQuantityIdentifier":{
                                "type":"string",
                                "maxLength":30,
                                "description":"SQI"
                            },
                            "billableServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Billable Service Quantity"
                            },
                            "measuresPeakQuantity":{
                                "type":"boolean",
                                "description":"Measures Peak Qty"
                            },
                            "descriptionOnBill":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Description on Bill"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "distributionDescription":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Distribution Code Description"
                            },
                            "isCharacteristicExist":{
                                "type":"boolean",
                                "description":"Characteristic exists",
                                "example":"false"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : billableCharge

Type: object

Show Source

• billableChargeId: string
  Maximum Length: 12

  Billable Charge ID

{
    "type":"object",
    "properties":{
        "billableChargeId":{
            "type":"string",
            "maxLength":12,
            "description":"Billable Charge ID"
        }
    }
}

Nested Schema : calculationLines

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "headerSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Header Sequence"
                    },
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Sequence"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            }
                        }
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code"
                    },
                    "characteristicValue":{
                        "type":"string",
                        "maxLength":16,
                        "description":"Characteristic Value"
                    },
                    "distributionCode":{
                        "type":"object",
                        "properties":{
                            "distributionCode":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Distribution Code"
                            }
                        }
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "rcSequence":{
                        "type":"number",
                        "maximum":9999,
                        "minimum":-9999,
                        "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                        "example":"10"
                    },
                    "shouldPrint":{
                        "type":"boolean",
                        "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                        "example":"true"
                    },
                    "shouldAppearInSummary":{
                        "type":"boolean",
                        "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                        "example":"true"
                    },
                    "calculatedAmount":{
                        "type":"number",
                        "description":"Calculated Amount"
                    },
                    "exemptAmount":{
                        "type":"number",
                        "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                        "example":"$0.00"
                    },
                    "baseAmount":{
                        "type":"number",
                        "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                        "example":"$102.71"
                    },
                    "serviceQuantityIdentifier":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI"
                    },
                    "billableServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Billable Service Quantity"
                    },
                    "measuresPeakQuantity":{
                        "type":"boolean",
                        "description":"Measures Peak Qty"
                    },
                    "descriptionOnBill":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Description on Bill"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "distributionDescription":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Distribution Code Description"
                    },
                    "isCharacteristicExist":{
                        "type":"boolean",
                        "description":"Characteristic exists",
                        "example":"false"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "headerSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Header Sequence"
            },
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Sequence"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    }
                }
            },
            "currency":{
                "type":"string",
                "maxLength":3,
                "description":"Currency Code"
            },
            "characteristicValue":{
                "type":"string",
                "maxLength":16,
                "description":"Characteristic Value"
            },
            "distributionCode":{
                "type":"object",
                "properties":{
                    "distributionCode":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Distribution Code"
                    }
                }
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use"
            },
            "rcSequence":{
                "type":"number",
                "maximum":9999,
                "minimum":-9999,
                "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                "example":"10"
            },
            "shouldPrint":{
                "type":"boolean",
                "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                "example":"true"
            },
            "shouldAppearInSummary":{
                "type":"boolean",
                "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                "example":"true"
            },
            "calculatedAmount":{
                "type":"number",
                "description":"Calculated Amount"
            },
            "exemptAmount":{
                "type":"number",
                "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                "example":"$0.00"
            },
            "baseAmount":{
                "type":"number",
                "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                "example":"$102.71"
            },
            "serviceQuantityIdentifier":{
                "type":"string",
                "maxLength":30,
                "description":"SQI"
            },
            "billableServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Billable Service Quantity"
            },
            "measuresPeakQuantity":{
                "type":"boolean",
                "description":"Measures Peak Qty"
            },
            "descriptionOnBill":{
                "type":"string",
                "maxLength":254,
                "description":"Description on Bill"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "distributionDescription":{
                "type":"string",
                "maxLength":30,
                "description":"Distribution Code Description"
            },
            "isCharacteristicExist":{
                "type":"boolean",
                "description":"Characteristic exists",
                "example":"false"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• baseAmount: number
  Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.

  Example: $102.71
• billableServiceQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Billable Service Quantity
• calculatedAmount: number
  Calculated Amount
• characteristicType: object characteristicType
• characteristicValue: string
  Maximum Length: 16

  Characteristic Value
• currency: string
  Maximum Length: 3

  Currency Code
• descriptionOnBill: string
  Maximum Length: 254

  Description on Bill
• distributionCode: object distributionCode
• distributionDescription: string
  Maximum Length: 30

  Distribution Code Description
• exemptAmount: number
  Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.

  Example: $0.00
• headerSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Header Sequence
• isCharacteristicExist: boolean
  Characteristic exists

  Example: false
• measuresPeakQuantity: boolean
  Measures Peak Qty
• rcSequence: number
  Minimum Value: -9999

  Maximum Value: 9999

  Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.

  Example: 10
• sequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Sequence
• serviceQuantityIdentifier: string
  Maximum Length: 30

  SQI
• shouldAppearInSummary: boolean
  The Appears in Summary switch defines if this line's amount also appears on a summary line.

  Example: true
• shouldPrint: boolean
  The Print switch controls whether information about this line will print on the customer's bill.

  Example: true
• timeOfUse: string
  Maximum Length: 30

  Time of Use
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "headerSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Header Sequence"
        },
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "characteristicValue":{
            "type":"string",
            "maxLength":16,
            "description":"Characteristic Value"
        },
        "distributionCode":{
            "type":"object",
            "properties":{
                "distributionCode":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Distribution Code"
                }
            }
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "rcSequence":{
            "type":"number",
            "maximum":9999,
            "minimum":-9999,
            "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
            "example":"10"
        },
        "shouldPrint":{
            "type":"boolean",
            "description":"The Print switch controls whether information about this line will print on the customer's bill.",
            "example":"true"
        },
        "shouldAppearInSummary":{
            "type":"boolean",
            "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
            "example":"true"
        },
        "calculatedAmount":{
            "type":"number",
            "description":"Calculated Amount"
        },
        "exemptAmount":{
            "type":"number",
            "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
            "example":"$0.00"
        },
        "baseAmount":{
            "type":"number",
            "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
            "example":"$102.71"
        },
        "serviceQuantityIdentifier":{
            "type":"string",
            "maxLength":30,
            "description":"SQI"
        },
        "billableServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Billable Service Quantity"
        },
        "measuresPeakQuantity":{
            "type":"boolean",
            "description":"Measures Peak Qty"
        },
        "descriptionOnBill":{
            "type":"string",
            "maxLength":254,
            "description":"Description on Bill"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "distributionDescription":{
            "type":"string",
            "maxLength":30,
            "description":"Distribution Code Description"
        },
        "isCharacteristicExist":{
            "type":"boolean",
            "description":"Characteristic exists",
            "example":"false"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• characteristicType: string
  Maximum Length: 8

  Characteristic Type

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

Nested Schema : distributionCode

Type: object

Show Source

• distributionCode: string
  Maximum Length: 10

  Distribution Code

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

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "financialTransactionId":{
                "type":"string",
                "maxLength":12,
                "description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).",
                "example":"211166656266"
            },
            "financialTransactionType":{
                "type":"string",
                "enum":[
                    "AD  ",
                    "AX  ",
                    "BS  ",
                    "BX  ",
                    "PS  ",
                    "PX  "
                ],
                "description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation",
                "example":"BS"
            },
            "financialTransactionTypeDescription":{
                "type":"string",
                "maxLength":150,
                "description":"FT Type Description"
            },
            "currentAmount":{
                "type":"number",
                "description":"Current Amount"
            },
            "accountingDate":{
                "type":"string",
                "format":"date",
                "description":"Accounting Date"
            },
            "arrearsDate":{
                "type":"string",
                "format":"date",
                "description":"Arrears Date is the date the FT starts aging.",
                "example":"03-04-2013"
            },
            "shouldShowOnBill":{
                "type":"boolean",
                "description":"Show on bill indicates if information about the FT appears on the customer's bill.",
                "example":"true"
            },
            "_data":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "sequence":{
                            "type":"number",
                            "maximum":999,
                            "minimum":-999,
                            "description":"Sequence"
                        },
                        "distributionCode":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Distribution Code"
                        },
                        "characteristicType":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Characteristic Type"
                        },
                        "characteristicValue":{
                            "type":"string",
                            "maxLength":16,
                            "description":"Characteristic Value"
                        },
                        "amount":{
                            "type":"number",
                            "description":"Amount defines the journal line's amount.",
                            "example":"$33.00"
                        },
                        "statistics":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                            "example":"CF"
                        },
                        "statisticAmount":{
                            "type":"number",
                            "maximum":1.0E13,
                            "minimum":-1.0E13,
                            "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                            "example":"0.000"
                        },
                        "isTotalAmount":{
                            "type":"boolean",
                            "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                            "example":"true"
                        },
                        "distributionDescription":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Distribution Code Description"
                        },
                        "version":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Version"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• _data: array _data
• accountingDate: string (date)
  Accounting Date
• arrearsDate: string (date)
  Arrears Date is the date the FT starts aging.

  Example: 03-04-2013
• currentAmount: number
  Current Amount
• financialTransactionId: string
  Maximum Length: 12

  FT ID is the system-assigned unique identifier of the financial transaction (FT).

  Example: 211166656266
• financialTransactionType: string
  Allowed Values: [ "AD ", "AX ", "BS ", "BX ", "PS ", "PX " ]

  Financial Transaction Type: AD - Adjustment, AX - Adjustment Cancellation, BS - Bill Segment, BX - Bill Segment Cancellation, PS - Pay Segment, PX - Pay Segment Cancellation * `AD ` - Adjustment, * `AX ` - Adjustment Cancellation, * `BS ` - Bill Segment, * `BX ` - Bill Segment Cancellation, * `PS ` - Pay Segment, * `PX ` - Pay Segment Cancellation

  Example: BS
• financialTransactionTypeDescription: string
  Maximum Length: 150

  FT Type Description
• shouldShowOnBill: boolean
  Show on bill indicates if information about the FT appears on the customer's bill.

  Example: true

{
    "type":"object",
    "properties":{
        "financialTransactionId":{
            "type":"string",
            "maxLength":12,
            "description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).",
            "example":"211166656266"
        },
        "financialTransactionType":{
            "type":"string",
            "enum":[
                "AD  ",
                "AX  ",
                "BS  ",
                "BX  ",
                "PS  ",
                "PX  "
            ],
            "description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation",
            "example":"BS"
        },
        "financialTransactionTypeDescription":{
            "type":"string",
            "maxLength":150,
            "description":"FT Type Description"
        },
        "currentAmount":{
            "type":"number",
            "description":"Current Amount"
        },
        "accountingDate":{
            "type":"string",
            "format":"date",
            "description":"Accounting Date"
        },
        "arrearsDate":{
            "type":"string",
            "format":"date",
            "description":"Arrears Date is the date the FT starts aging.",
            "example":"03-04-2013"
        },
        "shouldShowOnBill":{
            "type":"boolean",
            "description":"Show on bill indicates if information about the FT appears on the customer's bill.",
            "example":"true"
        },
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence"
                    },
                    "distributionCode":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Distribution Code"
                    },
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    },
                    "characteristicValue":{
                        "type":"string",
                        "maxLength":16,
                        "description":"Characteristic Value"
                    },
                    "amount":{
                        "type":"number",
                        "description":"Amount defines the journal line's amount.",
                        "example":"$33.00"
                    },
                    "statistics":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                        "example":"CF"
                    },
                    "statisticAmount":{
                        "type":"number",
                        "maximum":1.0E13,
                        "minimum":-1.0E13,
                        "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                        "example":"0.000"
                    },
                    "isTotalAmount":{
                        "type":"boolean",
                        "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                        "example":"true"
                    },
                    "distributionDescription":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Distribution Code Description"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence"
            },
            "distributionCode":{
                "type":"string",
                "maxLength":10,
                "description":"Distribution Code"
            },
            "characteristicType":{
                "type":"string",
                "maxLength":8,
                "description":"Characteristic Type"
            },
            "characteristicValue":{
                "type":"string",
                "maxLength":16,
                "description":"Characteristic Value"
            },
            "amount":{
                "type":"number",
                "description":"Amount defines the journal line's amount.",
                "example":"$33.00"
            },
            "statistics":{
                "type":"string",
                "maxLength":8,
                "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                "example":"CF"
            },
            "statisticAmount":{
                "type":"number",
                "maximum":1.0E13,
                "minimum":-1.0E13,
                "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                "example":"0.000"
            },
            "isTotalAmount":{
                "type":"boolean",
                "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                "example":"true"
            },
            "distributionDescription":{
                "type":"string",
                "maxLength":30,
                "description":"Distribution Code Description"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount: number
  Amount defines the journal line's amount.

  Example: $33.00
• characteristicType: string
  Maximum Length: 8

  Characteristic Type
• characteristicValue: string
  Maximum Length: 16

  Characteristic Value
• distributionCode: string
  Maximum Length: 10

  Distribution Code
• distributionDescription: string
  Maximum Length: 30

  Distribution Code Description
• isTotalAmount: boolean
  Total Amount defines if the journal line contains the total of the other journal lines.

  Example: true
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence
• statisticAmount: number
  Minimum Value: -1.0E13

  Maximum Value: 1.0E13

  Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.

  Example: 0.000
• statistics: string
  Maximum Length: 8

  Statistics Code is only specified when a statistical quantity is associated with the distribution line.

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

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence"
        },
        "distributionCode":{
            "type":"string",
            "maxLength":10,
            "description":"Distribution Code"
        },
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        },
        "characteristicValue":{
            "type":"string",
            "maxLength":16,
            "description":"Characteristic Value"
        },
        "amount":{
            "type":"number",
            "description":"Amount defines the journal line's amount.",
            "example":"$33.00"
        },
        "statistics":{
            "type":"string",
            "maxLength":8,
            "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
            "example":"CF"
        },
        "statisticAmount":{
            "type":"number",
            "maximum":1.0E13,
            "minimum":-1.0E13,
            "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
            "example":"0.000"
        },
        "isTotalAmount":{
            "type":"boolean",
            "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
            "example":"true"
        },
        "distributionDescription":{
            "type":"string",
            "maxLength":30,
            "description":"Distribution Code Description"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Sequence"
            },
            "itemType":{
                "type":"string",
                "maxLength":30,
                "description":"Item Type is the type of item.",
                "example":"Generic Current Transformer"
            },
            "item":{
                "type":"object",
                "properties":{
                    "item":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Item ID"
                    }
                }
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"Start Date"
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"End Date"
            },
            "itemCount":{
                "type":"number",
                "maximum":9.9999999999E8,
                "minimum":-9.9999999999E8,
                "description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.",
                "example":"1.00"
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "dailyServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Daily Service Quantity is the item's estimated amount of daily consumption.",
                "example":"470.762600"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dailyServiceQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Daily Service Quantity is the item's estimated amount of daily consumption.

  Example: 470.762600
• endDate: string (date)
  End Date
• item: object item
• itemCount: number
  Minimum Value: -9.9999999999E8

  Maximum Value: 9.9999999999E8

  Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.

  Example: 1.00
• itemType: string
  Maximum Length: 30

  Item Type is the type of item.

  Example: Generic Current Transformer
• sequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Sequence
• startDate: string (date)
  Start Date
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence"
        },
        "itemType":{
            "type":"string",
            "maxLength":30,
            "description":"Item Type is the type of item.",
            "example":"Generic Current Transformer"
        },
        "item":{
            "type":"object",
            "properties":{
                "item":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Item ID"
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date"
        },
        "itemCount":{
            "type":"number",
            "maximum":9.9999999999E8,
            "minimum":-9.9999999999E8,
            "description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.",
            "example":"1.00"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "dailyServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Daily Service Quantity is the item's estimated amount of daily consumption.",
            "example":"470.762600"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : item

Type: object

Show Source

• item: string
  Maximum Length: 10

  Item ID

{
    "type":"object",
    "properties":{
        "item":{
            "type":"string",
            "maxLength":10,
            "description":"Item ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "billMessageCode":{
                "type":"string",
                "maxLength":4,
                "description":"Bill Message"
            },
            "insert":{
                "type":"string",
                "maxLength":8,
                "description":"Insert Code defines if the bill message causes an insert in the envelope."
            },
            "messagePriority":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "40  ",
                    "50  ",
                    "60  ",
                    "70  ",
                    "80  ",
                    "90  "
                ],
                "description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest",
                "example":"20"
            },
            "messageOnBill":{
                "type":"string",
                "maxLength":254,
                "description":"Message On Bill is the message associated with the code.",
                "example":"Electric service not billed"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billMessageCode: string
  Maximum Length: 4

  Bill Message
• insert: string
  Maximum Length: 8

  Insert Code defines if the bill message causes an insert in the envelope.
• messageOnBill: string
  Maximum Length: 254

  Message On Bill is the message associated with the code.

  Example: Electric service not billed
• messagePriority: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "90 " ]

  Priority is the bill messages priority (on the printed bill). * `10 ` - Priority 10 -- Lowest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `90 ` - Priority 90 -- Highest

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

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "billMessageCode":{
            "type":"string",
            "maxLength":4,
            "description":"Bill Message"
        },
        "insert":{
            "type":"string",
            "maxLength":8,
            "description":"Insert Code defines if the bill message causes an insert in the envelope."
        },
        "messagePriority":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  ",
                "80  ",
                "90  "
            ],
            "description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest",
            "example":"20"
        },
        "messageOnBill":{
            "type":"string",
            "maxLength":254,
            "description":"Message On Bill is the message associated with the code.",
            "example":"Electric service not billed"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• action: string
  Allowed Values: [ "C1CF", "C1CO", "C1CR", "C1DE", "C1FR", "C1GN", "C1RO" ]

  Bill Web Service Actions: * `C1CF` - Cancel Frozen, * `C1CO` - Complete, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1RO` - ReOpen

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "C1CF",
                "C1CO",
                "C1CR",
                "C1DE",
                "C1FR",
                "C1GN",
                "C1RO"
            ],
            "description":"Bill Web Service Actions:\n* `C1CF` - Cancel Frozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "finalUnitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.",
                "example":"CF"
            },
            "finalTimeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Final Time of Use is the final time-of-use code of the calculation / audit read.",
                "example":"ON"
            },
            "finalServiceQuantityId":{
                "type":"string",
                "maxLength":30,
                "description":"Final SQI is the final service quantity identifier of the calculation / audit read.",
                "example":"DAMT"
            },
            "registerQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.",
                "example":"200.000000"
            },
            "servicePointId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID"
            },
            "meterConfigurationId":{
                "type":"string",
                "maxLength":10,
                "description":"Meter Configuration ID"
            },
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Sequence"
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use"
            },
            "serviceQuantityIdentifier":{
                "type":"string",
                "maxLength":30,
                "description":"SQI"
            },
            "startRegisterReading":{
                "type":"number",
                "maximum":9.99999999999999E8,
                "minimum":-9.99999999999999E8,
                "description":"Start Register Reading is the start register reading.",
                "example":"7201.000000"
            },
            "endRegisterReading":{
                "type":"number",
                "maximum":9.99999999999999E8,
                "minimum":-9.99999999999999E8,
                "description":"End Register Reading is the end register reading.",
                "example":"11578.000000"
            },
            "measuredQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive",
                "example":"4377.000000"
            },
            "registerConstant":{
                "type":"number",
                "maximum":999999.999999,
                "minimum":-999999.999999,
                "description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.",
                "example":"1.000000"
            },
            "howToUse":{
                "type":"string",
                "enum":[
                    "+   ",
                    "-   ",
                    "C   ",
                    "P   "
                ],
                "description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak",
                "example":"+"
            },
            "howToUseRead":{
                "type":"string",
                "enum":[
                    "+   ",
                    "-   ",
                    "C   ",
                    "S   ",
                    "X   "
                ],
                "description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit",
                "example":"+"
            },
            "usePercent":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Use Percent is the percentage of the total consumption that was billed.",
                "example":"100"
            },
            "measuresPeakQuantity":{
                "type":"boolean",
                "description":"Measures Peak Qty"
            },
            "startReadDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Start Read Date/Time is the date and time of the start meter read.",
                "example":"1998-06-30T00:00:00-04:00"
            },
            "endReadDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"End Read Date/Time is the date and time of the end meter read.",
                "example":"998-09-30T00:00:00-04:00"
            },
            "startRegisterReadId":{
                "type":"string",
                "maxLength":12,
                "description":"Start Register Read ID is the unique identifier of the start register read.",
                "example":"444074862768"
            },
            "endRegisterReadingId":{
                "type":"string",
                "maxLength":12,
                "description":"End Register Read ID is the unique identifier of the end register read.",
                "example":"444074849655"
            },
            "startRegisterReadTypeDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Start Register Read Type Description"
            },
            "endRegisterReadTypeDescription":{
                "type":"string",
                "maxLength":150,
                "description":"End Register Read Type Description"
            },
            "multiplier":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
                "example":"1.000000"
            },
            "consumptionType":{
                "type":"string",
                "enum":[
                    "C   ",
                    "S   "
                ],
                "description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive",
                "example":"S"
            },
            "notAvailableConsumptionDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Not Available Consumption Description"
            },
            "startMeterRead":{
                "type":"string",
                "maxLength":12,
                "description":"Start meter read ID",
                "example":"444074813104"
            },
            "endMeterRead":{
                "type":"string",
                "maxLength":12,
                "description":"End meter read ID",
                "example":"44074866808"
            },
            "meterReadId":{
                "type":"string",
                "maxLength":12,
                "description":"Meter Read ID",
                "example":"8833057699"
            },
            "unitOfMeasure2":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "serviceQuantityIdentifier2":{
                "type":"string",
                "maxLength":30,
                "description":"Service Quantity Identifier"
            },
            "timeOfUse2":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use"
            },
            "finalUomDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Final Uom Description"
            },
            "finalSqiDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Final SQI Description"
            },
            "finalTouDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Final TOU Description"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• consumptionType: string
  Allowed Values: [ "C ", "S " ]

  Consumptive/Subtractive flag shows if the register is consumptive or subtractive. * `C ` - Consumptive, * `S ` - Subtractive

  Example: S
• endMeterRead: string
  Maximum Length: 12

  End meter read ID

  Example: 44074866808
• endReadDateTime: string (date-time)
  End Read Date/Time is the date and time of the end meter read.

  Example: 998-09-30T00:00:00-04:00
• endRegisterReading: number
  Minimum Value: -9.99999999999999E8

  Maximum Value: 9.99999999999999E8

  End Register Reading is the end register reading.

  Example: 11578.000000
• endRegisterReadingId: string
  Maximum Length: 12

  End Register Read ID is the unique identifier of the end register read.

  Example: 444074849655
• endRegisterReadTypeDescription: string
  Maximum Length: 150

  End Register Read Type Description
• finalServiceQuantityId: string
  Maximum Length: 30

  Final SQI is the final service quantity identifier of the calculation / audit read.

  Example: DAMT
• finalSqiDescription: string
  Maximum Length: 150

  Final SQI Description
• finalTimeOfUse: string
  Maximum Length: 30

  Final Time of Use is the final time-of-use code of the calculation / audit read.

  Example: ON
• finalTouDescription: string
  Maximum Length: 150

  Final TOU Description
• finalUnitOfMeasure: string
  Maximum Length: 30

  Final Unit of Measure is the final unit of measure of the calculation / audit read.

  Example: CF
• finalUomDescription: string
  Maximum Length: 150

  Final Uom Description
• howToUse: string
  Allowed Values: [ "+ ", "- ", "C ", "P " ]

  How To Use is a code that indicates if the "calculation / audit" read was is considered to be additive, subtractive, peak or check. * `+ ` - Additive, * `- ` - Subtractive, * `C ` - Check, * `P ` - Peak

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

  How To Use (SP) is the SA/SP's how to use code. * `+ ` - Add, * `- ` - Subtract, * `C ` - Check, * `S ` - Service Quantity, * `X ` - Calculation/Audit

  Example: +
• measuredQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive

  Example: 4377.000000
• measuresPeakQuantity: boolean
  Measures Peak Qty
• meterConfigurationId: string
  Maximum Length: 10

  Meter Configuration ID
• meterReadId: string
  Maximum Length: 12

  Meter Read ID

  Example: 8833057699
• multiplier: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.

  Example: 1.000000
• notAvailableConsumptionDescription: string
  Maximum Length: 150

  Not Available Consumption Description
• registerConstant: number
  Minimum Value: -999999.999999

  Maximum Value: 999999.999999

  Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.

  Example: 1.000000
• registerQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.

  Example: 200.000000
• sequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Sequence
• servicePointId: string
  Maximum Length: 10

  Service Point ID
• serviceQuantityIdentifier: string
  Maximum Length: 30

  SQI
• serviceQuantityIdentifier2: string
  Maximum Length: 30

  Service Quantity Identifier
• startMeterRead: string
  Maximum Length: 12

  Start meter read ID

  Example: 444074813104
• startReadDateTime: string (date-time)
  Start Read Date/Time is the date and time of the start meter read.

  Example: 1998-06-30T00:00:00-04:00
• startRegisterReadId: string
  Maximum Length: 12

  Start Register Read ID is the unique identifier of the start register read.

  Example: 444074862768
• startRegisterReading: number
  Minimum Value: -9.99999999999999E8

  Maximum Value: 9.99999999999999E8

  Start Register Reading is the start register reading.

  Example: 7201.000000
• startRegisterReadTypeDescription: string
  Maximum Length: 150

  Start Register Read Type Description
• timeOfUse: string
  Maximum Length: 30

  Time of Use
• timeOfUse2: string
  Maximum Length: 30

  Time of Use
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure
• unitOfMeasure2: string
  Maximum Length: 30

  Unit of Measure
• usePercent: number
  Minimum Value: -999

  Maximum Value: 999

  Use Percent is the percentage of the total consumption that was billed.

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

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "finalUnitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.",
            "example":"CF"
        },
        "finalTimeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Final Time of Use is the final time-of-use code of the calculation / audit read.",
            "example":"ON"
        },
        "finalServiceQuantityId":{
            "type":"string",
            "maxLength":30,
            "description":"Final SQI is the final service quantity identifier of the calculation / audit read.",
            "example":"DAMT"
        },
        "registerQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.",
            "example":"200.000000"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        },
        "meterConfigurationId":{
            "type":"string",
            "maxLength":10,
            "description":"Meter Configuration ID"
        },
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "serviceQuantityIdentifier":{
            "type":"string",
            "maxLength":30,
            "description":"SQI"
        },
        "startRegisterReading":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":-9.99999999999999E8,
            "description":"Start Register Reading is the start register reading.",
            "example":"7201.000000"
        },
        "endRegisterReading":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":-9.99999999999999E8,
            "description":"End Register Reading is the end register reading.",
            "example":"11578.000000"
        },
        "measuredQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive",
            "example":"4377.000000"
        },
        "registerConstant":{
            "type":"number",
            "maximum":999999.999999,
            "minimum":-999999.999999,
            "description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.",
            "example":"1.000000"
        },
        "howToUse":{
            "type":"string",
            "enum":[
                "+   ",
                "-   ",
                "C   ",
                "P   "
            ],
            "description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak",
            "example":"+"
        },
        "howToUseRead":{
            "type":"string",
            "enum":[
                "+   ",
                "-   ",
                "C   ",
                "S   ",
                "X   "
            ],
            "description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit",
            "example":"+"
        },
        "usePercent":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Use Percent is the percentage of the total consumption that was billed.",
            "example":"100"
        },
        "measuresPeakQuantity":{
            "type":"boolean",
            "description":"Measures Peak Qty"
        },
        "startReadDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start Read Date/Time is the date and time of the start meter read.",
            "example":"1998-06-30T00:00:00-04:00"
        },
        "endReadDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"End Read Date/Time is the date and time of the end meter read.",
            "example":"998-09-30T00:00:00-04:00"
        },
        "startRegisterReadId":{
            "type":"string",
            "maxLength":12,
            "description":"Start Register Read ID is the unique identifier of the start register read.",
            "example":"444074862768"
        },
        "endRegisterReadingId":{
            "type":"string",
            "maxLength":12,
            "description":"End Register Read ID is the unique identifier of the end register read.",
            "example":"444074849655"
        },
        "startRegisterReadTypeDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Start Register Read Type Description"
        },
        "endRegisterReadTypeDescription":{
            "type":"string",
            "maxLength":150,
            "description":"End Register Read Type Description"
        },
        "multiplier":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
            "example":"1.000000"
        },
        "consumptionType":{
            "type":"string",
            "enum":[
                "C   ",
                "S   "
            ],
            "description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive",
            "example":"S"
        },
        "notAvailableConsumptionDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Not Available Consumption Description"
        },
        "startMeterRead":{
            "type":"string",
            "maxLength":12,
            "description":"Start meter read ID",
            "example":"444074813104"
        },
        "endMeterRead":{
            "type":"string",
            "maxLength":12,
            "description":"End meter read ID",
            "example":"44074866808"
        },
        "meterReadId":{
            "type":"string",
            "maxLength":12,
            "description":"Meter Read ID",
            "example":"8833057699"
        },
        "unitOfMeasure2":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "serviceQuantityIdentifier2":{
            "type":"string",
            "maxLength":30,
            "description":"Service Quantity Identifier"
        },
        "timeOfUse2":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "finalUomDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Final Uom Description"
        },
        "finalSqiDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Final SQI Description"
        },
        "finalTouDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Final TOU Description"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use"
            },
            "serviceQuantityIdentifier":{
                "type":"string",
                "maxLength":30,
                "description":"SQI"
            },
            "initialServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
                "example":"470.762600"
            },
            "billableServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Billable Service Quantity"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billableServiceQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Billable Service Quantity
• initialServiceQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.

  Example: 470.762600
• serviceQuantityIdentifier: string
  Maximum Length: 30

  SQI
• timeOfUse: string
  Maximum Length: 30

  Time of Use
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "serviceQuantityIdentifier":{
            "type":"string",
            "maxLength":30,
            "description":"SQI"
        },
        "initialServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
            "example":"470.762600"
        },
        "billableServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Billable Service Quantity"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "currentAmount":{
                "type":"number",
                "description":"Current Amount"
            },
            "billSegmentStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "40  ",
                    "50  ",
                    "60  ",
                    "70  "
                ],
                "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billSegmentStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]

  Bill Segment Status: * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `40 ` - Pending Cancel, * `50 ` - Frozen, * `60 ` - Canceled, * `70 ` - OK
• currentAmount: number
  Current Amount

{
    "type":"object",
    "properties":{
        "currentAmount":{
            "type":"number",
            "description":"Current Amount"
        },
        "billSegmentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• account: object account
• accountingDate: string (date)
  Accounting Date
• areEstimatesAllowed: boolean
  Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.

  Example: false
• bill: object bill
• billCycle: object billCycle
  Bill Cycle displays the bill cycle and window start date of the bill segment's bill.
• billScenarioId: string
  Maximum Length: 12

  Billing Scenario ID allows you to go to the proposal SA's billing scenario where you can tinker with consumption and the bill segment period used to generate this bill segment.
• billSegmentId: string
  Maximum Length: 12

  Bill Segment ID is the system-assigned unique identifier of the bill segment.

  Example: 211366855400
• billSegmentPeriod: string
  Maximum Length: 30

  Bill Segment Period is the start and end dates of the bill segment.

  Example: 11-04-2013 12-03-2013
• billSegmentStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]

  Bill Segment Status: * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `40 ` - Pending Cancel, * `50 ` - Frozen, * `60 ` - Canceled, * `70 ` - OK
• billSegmentStatusDescription: string
  Maximum Length: 150

  Description for bill segment's status.

  Example: Freezable
• billStatus: string
  Allowed Values: [ "C ", "P " ]

  Bill Status is the bill's status. * `C ` - Complete, * `P ` - Pending

  Example: C
• calcLines: object calcLines
• canActionRegenerate: boolean
  Regenerate action regenerated the bill segment after correcting the cause of the problem for errored bill segment.

  Example: false
• canCancel: boolean
  The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.

  Example: true
• cancelBillSegmentId: string
  Maximum Length: 12

  If the bill segment was canceled and rebilled by another segment, a reference to the new bill segment is displayed. Cancel Bill Segment ID refers to the new bill segment id that superseded the canceled segment.

  Example: 661660087111
• cancelReason: object cancelReason
  Cancel Reason defines why the bill segment(s) are being canceled.
• cancelReasonDescription: string
  Maximum Length: 100

  Cancel Reason Description defines the reason why the bill segment(s) are being canceled.

  Example: Canceled prior to completion.
• canDelete: boolean
  The Delete is used to delete one or more bill segments.

  Example: false
• canFreeze: boolean
  The Freeze is used to freeze one or more bill segments.
• canGenerate: boolean
  The Generate is used to delete and recreate one or more bill segments.

  Example: false
• canInitCancel: boolean
  Initialize Cancel causes the first step of the bill segment cancellation process to be executed. You'd click this button if a frozen bill segment should never have been created (i.e., you want to remove the financial impact of a bill segment from a customer's balance). This button is enabled when you display a Frozen bill segment AND the bill segment's bill is not written off.

  Example: false
• canShowAccountingDate: boolean
  Accounting Date is the date the system uses to determine the financial transaction's accounting period in your general ledger.

  Example: 06-05-2013
• canUndo: boolean
  Undo returns a Pending Cancel bill segment to the Frozen state.

  Example: false
• canUseOldReadsItemsServiceQuantity: boolean
  Check Use Old Read/Item/SQ if the system is configured to use the consumption details used on the original bill segments.

  Example: false
• correctionNote: string
  Maximum Length: 150

  The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.
• creationDateTime: string (date-time)
  Create Date/Time is the date and time on which the bill was originally created.

  Example: 2001-05-16
• creditDate: string (date)
  Bill Date is the business date that was used when the bill was completed.

  Example: 06-05-2013
• creditNote: string
  Maximum Length: 12

  The Credit Note is used to cancel selected bill segments and create a new bill that contains the cancellation details. We refer to this "negative bill" as a credit note.
• currency: object currency
• currentAmount: number
  Current Amount is the bill segment's effect on the service agreement's current balance.

  Example: $405.52
• cutOffDate: string (date)
  Cutoff Date is the last day of the new bill segment.

  Example: 2021-10-05
• exception: object exception
• financialDetails: object financialDetails
• hasBillingOption: boolean
  Billing Option
• hasServiceQuantityOverride: boolean
  SQ Override
• httpMethod: string
  Allowed Values: [ "DELT", "GET ", "POST", "PTCH", "PUT " ]

  HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put

  Example: GET
• isClosingBillSegment: boolean
  If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).

  Example: true
• isCorrectionNote: boolean
  The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.

  Example: false
• isCreditNote: boolean
  Credit Note is used to cancel ALL bill segments and create a new bill that contains the cancellation details.

  Example: false
• isEstimate: boolean
  If the Estimate switch is on, consumption on this bill segment has been estimated by the system.

  Example: true
• isItemOverride: boolean
  Item Override
• items: object items
• masterBillSegmentId: string
  Maximum Length: 12

  Master Bseg ID shows the unique identifier of the master bill segment whose bill triggered the creation of this sub service agreement.

  Example: 661660087111
• messages: object messages
• nextActions: array nextActions
• payoffAmount: number
  Payoff Amount is only shown if it differs from current amount.

  Example: $33.20
• periodEndDate: string (date)
  End Date
• periodStartDate: string (date)
  Start Date
• premise: object premise
• processDate: string (date)
  Process Date
• quote: object quote
• quoteDetailId: string
  Maximum Length: 12

  Quote Detail ID is the system-assigned unique identifier of the quote detail.
• readDetails: object readDetails
• saRelationshipId: string
  Maximum Length: 10

  SA Relationship ID shows the unique identifier of the record that defines the relationship between the sub service agreement and the master service agreement (this record shows the service provider associated with the bill segment).
• serviceAgreement: object serviceAgreement
  SA ID contains information about the bill segment's service agreement.
• serviceQuantities: object serviceQuantities
• shouldRebill: boolean
  The Rebill causes an existing bill segment to be canceled, and a new bill segment to be created.

  Example: true
• specialUsage: string
  Allowed Values: [ "PROP" ]

  Special Usage flag shows if it's a proposal SA. * `PROP` - Proposal SA

  Example: PROP
• statusChangeDateTime: string (date-time)
  Bill Segment's status change date/time

  Example: 06-05-2013 04:28PM
• subBillSegments: object subBillSegments
• usageEndDateTime: string (date-time)
  Usage end date is the last date for bill segment used by meter data management system.

  Example: 03-04-2013
• usagePeriod: string
  Maximum Length: 1

  Usage Period is the period used by the meter data management system to determine the correct interval data to process for the bill segment.

  Example: 11-04-2013 12-03-2013
• usageStartDateTime: string (date-time)
  Usage start date is the first day for bill segment used by meter data management system.

  Example: 03-04-2013
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version
• windowStartDate: string (date)
  Window Start Date

  Example: 12-03-2013

{
    "type":"object",
    "properties":{
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put",
            "example":"GET"
        },
        "billSegmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.",
            "example":"211366855400"
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID identifies the customer who is responsible for the bill.",
                    "example":"1112345900"
                }
            }
        },
        "currentAmount":{
            "type":"number",
            "description":"Current Amount is the bill segment's effect on the service agreement's current balance.",
            "example":"$405.52"
        },
        "payoffAmount":{
            "type":"number",
            "description":"Payoff Amount is only shown if it differs from current amount.",
            "example":"$33.20"
        },
        "bill":{
            "type":"object",
            "properties":{
                "billId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
                    "example":"211122345678"
                }
            }
        },
        "serviceAgreement":{
            "type":"object",
            "description":"SA ID contains information about the bill segment's service agreement.",
            "properties":{
                "serviceAgreement":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                }
            }
        },
        "periodStartDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date"
        },
        "periodEndDate":{
            "type":"string",
            "format":"date",
            "description":"End Date"
        },
        "usageStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Usage start date is the first day for bill segment used by meter data management system.",
            "example":"03-04-2013"
        },
        "usageEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Usage end date is the last date for bill segment used by meter data management system.",
            "example":"03-04-2013"
        },
        "billSegmentPeriod":{
            "type":"string",
            "maxLength":30,
            "description":"Bill Segment Period is the start and end dates of the bill segment.",
            "example":"11-04-2013 12-03-2013"
        },
        "usagePeriod":{
            "type":"string",
            "maxLength":1,
            "description":"Usage Period is the period used by the meter data management system to determine the correct interval data to process for the bill segment.",
            "example":"11-04-2013 12-03-2013"
        },
        "billCycle":{
            "type":"object",
            "description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.",
            "properties":{
                "billCycle":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.",
                    "example":"M-D2 (Monthly bill cycle - day 2)"
                }
            }
        },
        "billStatus":{
            "type":"string",
            "enum":[
                "C   ",
                "P   "
            ],
            "description":"Bill Status is the bill's status.\n* `C   ` - Complete,\n* `P   ` - Pending",
            "example":"C"
        },
        "isEstimate":{
            "type":"boolean",
            "description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.",
            "example":"true"
        },
        "isClosingBillSegment":{
            "type":"boolean",
            "description":"If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).",
            "example":"true"
        },
        "hasServiceQuantityOverride":{
            "type":"boolean",
            "description":"SQ Override"
        },
        "isItemOverride":{
            "type":"boolean",
            "description":"Item Override"
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."
                }
            }
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time is the date and time on which the bill was originally created.",
            "example":"2001-05-16"
        },
        "saRelationshipId":{
            "type":"string",
            "maxLength":10,
            "description":"SA Relationship ID shows the unique identifier of the record that defines the relationship between the sub service agreement and the master service agreement (this record shows the service provider associated with the bill segment)."
        },
        "billSegmentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
        },
        "billSegmentStatusDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Description for bill segment's status.",
            "example":"Freezable"
        },
        "statusChangeDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Bill Segment's status change date/time",
            "example":"06-05-2013 04:28PM"
        },
        "cancelReasonDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Cancel Reason Description defines the reason why the bill segment(s) are being canceled.",
            "example":"Canceled prior to completion."
        },
        "quote":{
            "type":"object",
            "properties":{
                "quoteId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Quote ID is the system-assigned unique identifier of the quote."
                }
            }
        },
        "cutOffDate":{
            "type":"string",
            "format":"date",
            "description":"Cutoff Date is the last day of the new bill segment.",
            "example":"2021-10-05"
        },
        "accountingDate":{
            "type":"string",
            "format":"date",
            "description":"Accounting Date"
        },
        "cancelReason":{
            "type":"object",
            "description":"Cancel Reason defines why the bill segment(s) are being canceled.",
            "properties":{
                "cancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Cancel Reason defines why the bill segment(s) are being canceled.",
                    "example":"Wrong read"
                }
            }
        },
        "areEstimatesAllowed":{
            "type":"boolean",
            "description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.",
            "example":"false"
        },
        "hasBillingOption":{
            "type":"boolean",
            "description":"Billing Option"
        },
        "canUseOldReadsItemsServiceQuantity":{
            "type":"boolean",
            "description":"Check Use Old Read/Item/SQ if the system is configured to use the consumption details used on the original bill segments.",
            "example":"false"
        },
        "creditDate":{
            "type":"string",
            "format":"date",
            "description":"Bill Date is the business date that was used when the bill was completed.",
            "example":"06-05-2013"
        },
        "creditNote":{
            "type":"string",
            "maxLength":12,
            "description":"The Credit Note is used to cancel selected bill segments and create a new bill that contains the cancellation details. We refer to this \"negative bill\" as a credit note."
        },
        "correctionNote":{
            "type":"string",
            "maxLength":150,
            "description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details."
        },
        "canShowAccountingDate":{
            "type":"boolean",
            "description":"Accounting Date  is the date the system uses to determine the financial transaction's accounting period in your general ledger.",
            "example":"06-05-2013"
        },
        "processDate":{
            "type":"string",
            "format":"date",
            "description":"Process Date"
        },
        "specialUsage":{
            "type":"string",
            "enum":[
                "PROP"
            ],
            "description":"Special Usage flag shows if it's a proposal SA.\n* `PROP` - Proposal SA",
            "example":"PROP"
        },
        "currency":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code"
                }
            }
        },
        "windowStartDate":{
            "type":"string",
            "format":"date",
            "description":"Window Start Date",
            "example":"12-03-2013"
        },
        "cancelBillSegmentId":{
            "type":"string",
            "maxLength":12,
            "description":"If the bill segment was canceled and rebilled by another segment, a reference to the new bill segment is displayed. Cancel Bill Segment ID refers to the new bill segment id that superseded the canceled segment.",
            "example":"661660087111"
        },
        "masterBillSegmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Master Bseg ID shows the unique identifier of the master bill segment whose bill triggered the creation of this sub service agreement.",
            "example":"661660087111"
        },
        "quoteDetailId":{
            "type":"string",
            "maxLength":12,
            "description":"Quote Detail ID is the system-assigned unique identifier of the quote detail."
        },
        "billScenarioId":{
            "type":"string",
            "maxLength":12,
            "description":"Billing Scenario ID allows you to go to the proposal SA's billing scenario where you can tinker with consumption and the bill segment period used to generate this bill segment."
        },
        "canCancel":{
            "type":"boolean",
            "description":"The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.",
            "example":"true"
        },
        "canDelete":{
            "type":"boolean",
            "description":"The Delete is used to delete one or more bill segments.",
            "example":"false"
        },
        "canFreeze":{
            "type":"boolean",
            "description":"The Freeze is used to freeze one or more bill segments."
        },
        "canGenerate":{
            "type":"boolean",
            "description":"The Generate is used to delete and recreate one or more bill segments.",
            "example":"false"
        },
        "canInitCancel":{
            "type":"boolean",
            "description":"Initialize  Cancel causes the first step of the bill segment cancellation process to be executed. You'd click this button if a frozen bill segment should never have been created (i.e., you want to remove the financial impact of a bill segment from a customer's balance).\n\nThis button is enabled when you display a Frozen bill segment AND the bill segment's bill is not written off.",
            "example":"false"
        },
        "shouldRebill":{
            "type":"boolean",
            "description":"The Rebill causes an existing bill segment to be canceled, and a new bill segment to be created.",
            "example":"true"
        },
        "canActionRegenerate":{
            "type":"boolean",
            "description":"Regenerate action regenerated the bill segment after correcting the cause of the problem for errored bill segment.",
            "example":"false"
        },
        "canUndo":{
            "type":"boolean",
            "description":"Undo returns a Pending Cancel bill segment to the Frozen state.",
            "example":"false"
        },
        "isCreditNote":{
            "type":"boolean",
            "description":"Credit Note is used to cancel ALL bill segments and create a new bill that contains the cancellation details.",
            "example":"false"
        },
        "isCorrectionNote":{
            "type":"boolean",
            "description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.",
            "example":"false"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "exception":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message category within Oracle Utilities Application Framework.",
                    "example":"0"
                },
                "messageNumber":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message number within Oracle Utilities Application Framework.",
                    "example":"0"
                },
                "expandedMessage":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Expanded Message exception"
                }
            }
        },
        "readDetails":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "finalUnitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.",
                                "example":"CF"
                            },
                            "finalTimeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Final Time of Use is the final time-of-use code of the calculation / audit read.",
                                "example":"ON"
                            },
                            "finalServiceQuantityId":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Final SQI is the final service quantity identifier of the calculation / audit read.",
                                "example":"DAMT"
                            },
                            "registerQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.",
                                "example":"200.000000"
                            },
                            "servicePointId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID"
                            },
                            "meterConfigurationId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Meter Configuration ID"
                            },
                            "sequence":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Sequence"
                            },
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "timeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            },
                            "serviceQuantityIdentifier":{
                                "type":"string",
                                "maxLength":30,
                                "description":"SQI"
                            },
                            "startRegisterReading":{
                                "type":"number",
                                "maximum":9.99999999999999E8,
                                "minimum":-9.99999999999999E8,
                                "description":"Start Register Reading is the start register reading.",
                                "example":"7201.000000"
                            },
                            "endRegisterReading":{
                                "type":"number",
                                "maximum":9.99999999999999E8,
                                "minimum":-9.99999999999999E8,
                                "description":"End Register Reading is the end register reading.",
                                "example":"11578.000000"
                            },
                            "measuredQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive",
                                "example":"4377.000000"
                            },
                            "registerConstant":{
                                "type":"number",
                                "maximum":999999.999999,
                                "minimum":-999999.999999,
                                "description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.",
                                "example":"1.000000"
                            },
                            "howToUse":{
                                "type":"string",
                                "enum":[
                                    "+   ",
                                    "-   ",
                                    "C   ",
                                    "P   "
                                ],
                                "description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak",
                                "example":"+"
                            },
                            "howToUseRead":{
                                "type":"string",
                                "enum":[
                                    "+   ",
                                    "-   ",
                                    "C   ",
                                    "S   ",
                                    "X   "
                                ],
                                "description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit",
                                "example":"+"
                            },
                            "usePercent":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Use Percent is the percentage of the total consumption that was billed.",
                                "example":"100"
                            },
                            "measuresPeakQuantity":{
                                "type":"boolean",
                                "description":"Measures Peak Qty"
                            },
                            "startReadDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Start Read Date/Time is the date and time of the start meter read.",
                                "example":"1998-06-30T00:00:00-04:00"
                            },
                            "endReadDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"End Read Date/Time is the date and time of the end meter read.",
                                "example":"998-09-30T00:00:00-04:00"
                            },
                            "startRegisterReadId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Start Register Read ID is the unique identifier of the start register read.",
                                "example":"444074862768"
                            },
                            "endRegisterReadingId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"End Register Read ID is the unique identifier of the end register read.",
                                "example":"444074849655"
                            },
                            "startRegisterReadTypeDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Start Register Read Type Description"
                            },
                            "endRegisterReadTypeDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"End Register Read Type Description"
                            },
                            "multiplier":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
                                "example":"1.000000"
                            },
                            "consumptionType":{
                                "type":"string",
                                "enum":[
                                    "C   ",
                                    "S   "
                                ],
                                "description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive",
                                "example":"S"
                            },
                            "notAvailableConsumptionDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Not Available Consumption Description"
                            },
                            "startMeterRead":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Start meter read ID",
                                "example":"444074813104"
                            },
                            "endMeterRead":{
                                "type":"string",
                                "maxLength":12,
                                "description":"End meter read ID",
                                "example":"44074866808"
                            },
                            "meterReadId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Meter Read ID",
                                "example":"8833057699"
                            },
                            "unitOfMeasure2":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "serviceQuantityIdentifier2":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Service Quantity Identifier"
                            },
                            "timeOfUse2":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            },
                            "finalUomDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Final Uom Description"
                            },
                            "finalSqiDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Final SQI Description"
                            },
                            "finalTouDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Final TOU Description"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "items":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Sequence"
                            },
                            "itemType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Item Type is the type of item.",
                                "example":"Generic Current Transformer"
                            },
                            "item":{
                                "type":"object",
                                "properties":{
                                    "item":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Item ID"
                                    }
                                }
                            },
                            "startDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Start Date"
                            },
                            "endDate":{
                                "type":"string",
                                "format":"date",
                                "description":"End Date"
                            },
                            "itemCount":{
                                "type":"number",
                                "maximum":9.9999999999E8,
                                "minimum":-9.9999999999E8,
                                "description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.",
                                "example":"1.00"
                            },
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "dailyServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Daily Service Quantity is the item's estimated amount of daily consumption.",
                                "example":"470.762600"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "serviceQuantities":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "timeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            },
                            "serviceQuantityIdentifier":{
                                "type":"string",
                                "maxLength":30,
                                "description":"SQI"
                            },
                            "initialServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
                                "example":"470.762600"
                            },
                            "billableServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Billable Service Quantity"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "calcLines":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "headerSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Header Sequence"
                            },
                            "startDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Start Date"
                            },
                            "endDate":{
                                "type":"string",
                                "format":"date",
                                "description":"End Date"
                            },
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code"
                            },
                            "calculatedAmount":{
                                "type":"number",
                                "description":"Calculated Amount"
                            },
                            "rateSchedule":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Rate Schedule"
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "billableCharge":{
                                "type":"object",
                                "properties":{
                                    "billableChargeId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Billable Charge ID"
                                    }
                                }
                            },
                            "descriptionOnBill":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Description on Bill"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "calculationLines":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "headerSequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Header Sequence"
                                                },
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Sequence"
                                                },
                                                "characteristicType":{
                                                    "type":"object",
                                                    "properties":{
                                                        "characteristicType":{
                                                            "type":"string",
                                                            "maxLength":8,
                                                            "description":"Characteristic Type"
                                                        }
                                                    }
                                                },
                                                "currency":{
                                                    "type":"string",
                                                    "maxLength":3,
                                                    "description":"Currency Code"
                                                },
                                                "characteristicValue":{
                                                    "type":"string",
                                                    "maxLength":16,
                                                    "description":"Characteristic Value"
                                                },
                                                "distributionCode":{
                                                    "type":"object",
                                                    "properties":{
                                                        "distributionCode":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Distribution Code"
                                                        }
                                                    }
                                                },
                                                "unitOfMeasure":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Unit of Measure"
                                                },
                                                "timeOfUse":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Time of Use"
                                                },
                                                "rcSequence":{
                                                    "type":"number",
                                                    "maximum":9999,
                                                    "minimum":-9999,
                                                    "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                                                    "example":"10"
                                                },
                                                "shouldPrint":{
                                                    "type":"boolean",
                                                    "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                                    "example":"true"
                                                },
                                                "shouldAppearInSummary":{
                                                    "type":"boolean",
                                                    "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                                    "example":"true"
                                                },
                                                "calculatedAmount":{
                                                    "type":"number",
                                                    "description":"Calculated Amount"
                                                },
                                                "exemptAmount":{
                                                    "type":"number",
                                                    "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                                                    "example":"$0.00"
                                                },
                                                "baseAmount":{
                                                    "type":"number",
                                                    "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                                                    "example":"$102.71"
                                                },
                                                "serviceQuantityIdentifier":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"SQI"
                                                },
                                                "billableServiceQuantity":{
                                                    "type":"number",
                                                    "maximum":1.0E12,
                                                    "minimum":-1.0E12,
                                                    "description":"Billable Service Quantity"
                                                },
                                                "measuresPeakQuantity":{
                                                    "type":"boolean",
                                                    "description":"Measures Peak Qty"
                                                },
                                                "descriptionOnBill":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Description on Bill"
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                },
                                                "distributionDescription":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Distribution Code Description"
                                                },
                                                "isCharacteristicExist":{
                                                    "type":"boolean",
                                                    "description":"Characteristic exists",
                                                    "example":"false"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "financialDetails":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "financialTransactionId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).",
                                "example":"211166656266"
                            },
                            "financialTransactionType":{
                                "type":"string",
                                "enum":[
                                    "AD  ",
                                    "AX  ",
                                    "BS  ",
                                    "BX  ",
                                    "PS  ",
                                    "PX  "
                                ],
                                "description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation",
                                "example":"BS"
                            },
                            "financialTransactionTypeDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"FT Type Description"
                            },
                            "currentAmount":{
                                "type":"number",
                                "description":"Current Amount"
                            },
                            "accountingDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Accounting Date"
                            },
                            "arrearsDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Arrears Date is the date the FT starts aging.",
                                "example":"03-04-2013"
                            },
                            "shouldShowOnBill":{
                                "type":"boolean",
                                "description":"Show on bill indicates if information about the FT appears on the customer's bill.",
                                "example":"true"
                            },
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Sequence"
                                        },
                                        "distributionCode":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Distribution Code"
                                        },
                                        "characteristicType":{
                                            "type":"string",
                                            "maxLength":8,
                                            "description":"Characteristic Type"
                                        },
                                        "characteristicValue":{
                                            "type":"string",
                                            "maxLength":16,
                                            "description":"Characteristic Value"
                                        },
                                        "amount":{
                                            "type":"number",
                                            "description":"Amount defines the journal line's amount.",
                                            "example":"$33.00"
                                        },
                                        "statistics":{
                                            "type":"string",
                                            "maxLength":8,
                                            "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                                            "example":"CF"
                                        },
                                        "statisticAmount":{
                                            "type":"number",
                                            "maximum":1.0E13,
                                            "minimum":-1.0E13,
                                            "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                                            "example":"0.000"
                                        },
                                        "isTotalAmount":{
                                            "type":"boolean",
                                            "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                                            "example":"true"
                                        },
                                        "distributionDescription":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Distribution Code Description"
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "subBillSegments":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "currentAmount":{
                                "type":"number",
                                "description":"Current Amount"
                            },
                            "billSegmentStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "40  ",
                                    "50  ",
                                    "60  ",
                                    "70  "
                                ],
                                "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
                            }
                        }
                    }
                }
            }
        },
        "messages":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "billMessageCode":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Bill Message"
                            },
                            "insert":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Insert Code defines if the bill message causes an insert in the envelope."
                            },
                            "messagePriority":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "40  ",
                                    "50  ",
                                    "60  ",
                                    "70  ",
                                    "80  ",
                                    "90  "
                                ],
                                "description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest",
                                "example":"20"
                            },
                            "messageOnBill":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Message On Bill is the message associated with the code.",
                                "example":"Electric service not billed"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "nextActions":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "action":{
                        "type":"string",
                        "enum":[
                            "C1CF",
                            "C1CO",
                            "C1CR",
                            "C1DE",
                            "C1FR",
                            "C1GN",
                            "C1RO"
                        ],
                        "description":"Bill Web Service Actions:\n* `C1CF` - Cancel Frozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-BillSegm"
    }
}

Nested Schema : account

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID identifies the customer who is responsible for the bill.

  Example: 1112345900

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID identifies the customer who is responsible for the bill.",
            "example":"1112345900"
        }
    }
}

Nested Schema : bill

Type: object

Show Source

• billId: string
  Maximum Length: 12

  Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.

  Example: 211122345678

{
    "type":"object",
    "properties":{
        "billId":{
            "type":"string",
            "maxLength":12,
            "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
            "example":"211122345678"
        }
    }
}

Nested Schema : billCycle

Type: object

Bill Cycle displays the bill cycle and window start date of the bill segment's bill.

Show Source

• billCycle: string
  Maximum Length: 4

  Bill Cycle displays the bill cycle and window start date of the bill segment's bill.

  Example: M-D2 (Monthly bill cycle - day 2)

{
    "type":"object",
    "description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.",
    "properties":{
        "billCycle":{
            "type":"string",
            "maxLength":4,
            "description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.",
            "example":"M-D2 (Monthly bill cycle - day 2)"
        }
    }
}

Nested Schema : calcLines

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "headerSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Header Sequence"
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Start Date"
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"End Date"
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code"
                    },
                    "calculatedAmount":{
                        "type":"number",
                        "description":"Calculated Amount"
                    },
                    "rateSchedule":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Rate Schedule"
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "billableCharge":{
                        "type":"object",
                        "properties":{
                            "billableChargeId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Billable Charge ID"
                            }
                        }
                    },
                    "descriptionOnBill":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Description on Bill"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "calculationLines":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "headerSequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Header Sequence"
                                        },
                                        "sequence":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Sequence"
                                        },
                                        "characteristicType":{
                                            "type":"object",
                                            "properties":{
                                                "characteristicType":{
                                                    "type":"string",
                                                    "maxLength":8,
                                                    "description":"Characteristic Type"
                                                }
                                            }
                                        },
                                        "currency":{
                                            "type":"string",
                                            "maxLength":3,
                                            "description":"Currency Code"
                                        },
                                        "characteristicValue":{
                                            "type":"string",
                                            "maxLength":16,
                                            "description":"Characteristic Value"
                                        },
                                        "distributionCode":{
                                            "type":"object",
                                            "properties":{
                                                "distributionCode":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Distribution Code"
                                                }
                                            }
                                        },
                                        "unitOfMeasure":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Unit of Measure"
                                        },
                                        "timeOfUse":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Time of Use"
                                        },
                                        "rcSequence":{
                                            "type":"number",
                                            "maximum":9999,
                                            "minimum":-9999,
                                            "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                                            "example":"10"
                                        },
                                        "shouldPrint":{
                                            "type":"boolean",
                                            "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                            "example":"true"
                                        },
                                        "shouldAppearInSummary":{
                                            "type":"boolean",
                                            "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                            "example":"true"
                                        },
                                        "calculatedAmount":{
                                            "type":"number",
                                            "description":"Calculated Amount"
                                        },
                                        "exemptAmount":{
                                            "type":"number",
                                            "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                                            "example":"$0.00"
                                        },
                                        "baseAmount":{
                                            "type":"number",
                                            "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                                            "example":"$102.71"
                                        },
                                        "serviceQuantityIdentifier":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"SQI"
                                        },
                                        "billableServiceQuantity":{
                                            "type":"number",
                                            "maximum":1.0E12,
                                            "minimum":-1.0E12,
                                            "description":"Billable Service Quantity"
                                        },
                                        "measuresPeakQuantity":{
                                            "type":"boolean",
                                            "description":"Measures Peak Qty"
                                        },
                                        "descriptionOnBill":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Description on Bill"
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        },
                                        "distributionDescription":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Distribution Code Description"
                                        },
                                        "isCharacteristicExist":{
                                            "type":"boolean",
                                            "description":"Characteristic exists",
                                            "example":"false"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : cancelReason

Type: object

Cancel Reason defines why the bill segment(s) are being canceled.

Show Source

• cancelReason: string
  Maximum Length: 4

  Cancel Reason defines why the bill segment(s) are being canceled.

  Example: Wrong read

{
    "type":"object",
    "description":"Cancel Reason defines why the bill segment(s) are being canceled.",
    "properties":{
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason defines why the bill segment(s) are being canceled.",
            "example":"Wrong read"
        }
    }
}

Nested Schema : currency

Type: object

Show Source

• currency: string
  Maximum Length: 3

  Currency Code

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

Nested Schema : exception

Type: object

Show Source

• expandedMessage: string
  Maximum Length: 254

  Expanded Message exception
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message category within Oracle Utilities Application Framework.

  Example: 0
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message number within Oracle Utilities Application Framework.

  Example: 0

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message category within Oracle Utilities Application Framework.",
            "example":"0"
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message number within Oracle Utilities Application Framework.",
            "example":"0"
        },
        "expandedMessage":{
            "type":"string",
            "maxLength":254,
            "description":"Expanded Message exception"
        }
    }
}

Nested Schema : financialDetails

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "financialTransactionId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).",
                        "example":"211166656266"
                    },
                    "financialTransactionType":{
                        "type":"string",
                        "enum":[
                            "AD  ",
                            "AX  ",
                            "BS  ",
                            "BX  ",
                            "PS  ",
                            "PX  "
                        ],
                        "description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation",
                        "example":"BS"
                    },
                    "financialTransactionTypeDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"FT Type Description"
                    },
                    "currentAmount":{
                        "type":"number",
                        "description":"Current Amount"
                    },
                    "accountingDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Accounting Date"
                    },
                    "arrearsDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Arrears Date is the date the FT starts aging.",
                        "example":"03-04-2013"
                    },
                    "shouldShowOnBill":{
                        "type":"boolean",
                        "description":"Show on bill indicates if information about the FT appears on the customer's bill.",
                        "example":"true"
                    },
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence"
                                },
                                "distributionCode":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Distribution Code"
                                },
                                "characteristicType":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"Characteristic Type"
                                },
                                "characteristicValue":{
                                    "type":"string",
                                    "maxLength":16,
                                    "description":"Characteristic Value"
                                },
                                "amount":{
                                    "type":"number",
                                    "description":"Amount defines the journal line's amount.",
                                    "example":"$33.00"
                                },
                                "statistics":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                                    "example":"CF"
                                },
                                "statisticAmount":{
                                    "type":"number",
                                    "maximum":1.0E13,
                                    "minimum":-1.0E13,
                                    "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                                    "example":"0.000"
                                },
                                "isTotalAmount":{
                                    "type":"boolean",
                                    "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                                    "example":"true"
                                },
                                "distributionDescription":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Distribution Code Description"
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Sequence"
                    },
                    "itemType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Item Type is the type of item.",
                        "example":"Generic Current Transformer"
                    },
                    "item":{
                        "type":"object",
                        "properties":{
                            "item":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Item ID"
                            }
                        }
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Start Date"
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"End Date"
                    },
                    "itemCount":{
                        "type":"number",
                        "maximum":9.9999999999E8,
                        "minimum":-9.9999999999E8,
                        "description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.",
                        "example":"1.00"
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "dailyServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Daily Service Quantity is the item's estimated amount of daily consumption.",
                        "example":"470.762600"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : messages

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "billMessageCode":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Bill Message"
                    },
                    "insert":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Insert Code defines if the bill message causes an insert in the envelope."
                    },
                    "messagePriority":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  ",
                            "50  ",
                            "60  ",
                            "70  ",
                            "80  ",
                            "90  "
                        ],
                        "description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest",
                        "example":"20"
                    },
                    "messageOnBill":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Message On Bill is the message associated with the code.",
                        "example":"Electric service not billed"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : nextActions

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "action":{
                "type":"string",
                "enum":[
                    "C1CF",
                    "C1CO",
                    "C1CR",
                    "C1DE",
                    "C1FR",
                    "C1GN",
                    "C1RO"
                ],
                "description":"Bill Web Service Actions:\n* `C1CF` - Cancel Frozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen"
            }
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• premiseId: string
  Maximum Length: 10

  Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise.

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."
        }
    }
}

Nested Schema : quote

Type: object

Show Source

• quoteId: string
  Maximum Length: 12

  Quote ID is the system-assigned unique identifier of the quote.

{
    "type":"object",
    "properties":{
        "quoteId":{
            "type":"string",
            "maxLength":12,
            "description":"Quote ID is the system-assigned unique identifier of the quote."
        }
    }
}

Nested Schema : readDetails

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "finalUnitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.",
                        "example":"CF"
                    },
                    "finalTimeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Final Time of Use is the final time-of-use code of the calculation / audit read.",
                        "example":"ON"
                    },
                    "finalServiceQuantityId":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Final SQI is the final service quantity identifier of the calculation / audit read.",
                        "example":"DAMT"
                    },
                    "registerQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.",
                        "example":"200.000000"
                    },
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID"
                    },
                    "meterConfigurationId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Meter Configuration ID"
                    },
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Sequence"
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "serviceQuantityIdentifier":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI"
                    },
                    "startRegisterReading":{
                        "type":"number",
                        "maximum":9.99999999999999E8,
                        "minimum":-9.99999999999999E8,
                        "description":"Start Register Reading is the start register reading.",
                        "example":"7201.000000"
                    },
                    "endRegisterReading":{
                        "type":"number",
                        "maximum":9.99999999999999E8,
                        "minimum":-9.99999999999999E8,
                        "description":"End Register Reading is the end register reading.",
                        "example":"11578.000000"
                    },
                    "measuredQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive",
                        "example":"4377.000000"
                    },
                    "registerConstant":{
                        "type":"number",
                        "maximum":999999.999999,
                        "minimum":-999999.999999,
                        "description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.",
                        "example":"1.000000"
                    },
                    "howToUse":{
                        "type":"string",
                        "enum":[
                            "+   ",
                            "-   ",
                            "C   ",
                            "P   "
                        ],
                        "description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak",
                        "example":"+"
                    },
                    "howToUseRead":{
                        "type":"string",
                        "enum":[
                            "+   ",
                            "-   ",
                            "C   ",
                            "S   ",
                            "X   "
                        ],
                        "description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit",
                        "example":"+"
                    },
                    "usePercent":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Use Percent is the percentage of the total consumption that was billed.",
                        "example":"100"
                    },
                    "measuresPeakQuantity":{
                        "type":"boolean",
                        "description":"Measures Peak Qty"
                    },
                    "startReadDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Start Read Date/Time is the date and time of the start meter read.",
                        "example":"1998-06-30T00:00:00-04:00"
                    },
                    "endReadDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"End Read Date/Time is the date and time of the end meter read.",
                        "example":"998-09-30T00:00:00-04:00"
                    },
                    "startRegisterReadId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Start Register Read ID is the unique identifier of the start register read.",
                        "example":"444074862768"
                    },
                    "endRegisterReadingId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"End Register Read ID is the unique identifier of the end register read.",
                        "example":"444074849655"
                    },
                    "startRegisterReadTypeDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Start Register Read Type Description"
                    },
                    "endRegisterReadTypeDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"End Register Read Type Description"
                    },
                    "multiplier":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
                        "example":"1.000000"
                    },
                    "consumptionType":{
                        "type":"string",
                        "enum":[
                            "C   ",
                            "S   "
                        ],
                        "description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive",
                        "example":"S"
                    },
                    "notAvailableConsumptionDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Not Available Consumption Description"
                    },
                    "startMeterRead":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Start meter read ID",
                        "example":"444074813104"
                    },
                    "endMeterRead":{
                        "type":"string",
                        "maxLength":12,
                        "description":"End meter read ID",
                        "example":"44074866808"
                    },
                    "meterReadId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Meter Read ID",
                        "example":"8833057699"
                    },
                    "unitOfMeasure2":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "serviceQuantityIdentifier2":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service Quantity Identifier"
                    },
                    "timeOfUse2":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "finalUomDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Final Uom Description"
                    },
                    "finalSqiDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Final SQI Description"
                    },
                    "finalTouDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Final TOU Description"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : serviceAgreement

Type: object

SA ID contains information about the bill segment's service agreement.

Show Source

• serviceAgreement: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "description":"SA ID contains information about the bill segment's service agreement.",
    "properties":{
        "serviceAgreement":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

Nested Schema : serviceQuantities

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "serviceQuantityIdentifier":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI"
                    },
                    "initialServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
                        "example":"470.762600"
                    },
                    "billableServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Billable Service Quantity"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : subBillSegments

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "currentAmount":{
                        "type":"number",
                        "description":"Current Amount"
                    },
                    "billSegmentStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  ",
                            "50  ",
                            "60  ",
                            "70  "
                        ],
                        "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "headerSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Header Sequence"
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"Start Date"
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"End Date"
            },
            "currency":{
                "type":"string",
                "maxLength":3,
                "description":"Currency Code"
            },
            "calculatedAmount":{
                "type":"number",
                "description":"Calculated Amount"
            },
            "rateSchedule":{
                "type":"string",
                "maxLength":8,
                "description":"Rate Schedule"
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "billableCharge":{
                "type":"object",
                "properties":{
                    "billableChargeId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Billable Charge ID"
                    }
                }
            },
            "descriptionOnBill":{
                "type":"string",
                "maxLength":254,
                "description":"Description on Bill"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "calculationLines":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "headerSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Header Sequence"
                                },
                                "sequence":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Sequence"
                                },
                                "characteristicType":{
                                    "type":"object",
                                    "properties":{
                                        "characteristicType":{
                                            "type":"string",
                                            "maxLength":8,
                                            "description":"Characteristic Type"
                                        }
                                    }
                                },
                                "currency":{
                                    "type":"string",
                                    "maxLength":3,
                                    "description":"Currency Code"
                                },
                                "characteristicValue":{
                                    "type":"string",
                                    "maxLength":16,
                                    "description":"Characteristic Value"
                                },
                                "distributionCode":{
                                    "type":"object",
                                    "properties":{
                                        "distributionCode":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Distribution Code"
                                        }
                                    }
                                },
                                "unitOfMeasure":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Unit of Measure"
                                },
                                "timeOfUse":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Time of Use"
                                },
                                "rcSequence":{
                                    "type":"number",
                                    "maximum":9999,
                                    "minimum":-9999,
                                    "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                                    "example":"10"
                                },
                                "shouldPrint":{
                                    "type":"boolean",
                                    "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                    "example":"true"
                                },
                                "shouldAppearInSummary":{
                                    "type":"boolean",
                                    "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                    "example":"true"
                                },
                                "calculatedAmount":{
                                    "type":"number",
                                    "description":"Calculated Amount"
                                },
                                "exemptAmount":{
                                    "type":"number",
                                    "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                                    "example":"$0.00"
                                },
                                "baseAmount":{
                                    "type":"number",
                                    "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                                    "example":"$102.71"
                                },
                                "serviceQuantityIdentifier":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"SQI"
                                },
                                "billableServiceQuantity":{
                                    "type":"number",
                                    "maximum":1.0E12,
                                    "minimum":-1.0E12,
                                    "description":"Billable Service Quantity"
                                },
                                "measuresPeakQuantity":{
                                    "type":"boolean",
                                    "description":"Measures Peak Qty"
                                },
                                "descriptionOnBill":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Description on Bill"
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                },
                                "distributionDescription":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Distribution Code Description"
                                },
                                "isCharacteristicExist":{
                                    "type":"boolean",
                                    "description":"Characteristic exists",
                                    "example":"false"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billableCharge: object billableCharge
• calculatedAmount: number
  Calculated Amount
• calculationLines: object calculationLines
• currency: string
  Maximum Length: 3

  Currency Code
• descriptionOnBill: string
  Maximum Length: 254

  Description on Bill
• effectiveDate: string (date)
  Effective Date
• endDate: string (date)
  End Date
• headerSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Header Sequence
• rateSchedule: string
  Maximum Length: 8

  Rate Schedule
• startDate: string (date)
  Start Date
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "headerSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Header Sequence"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date"
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "calculatedAmount":{
            "type":"number",
            "description":"Calculated Amount"
        },
        "rateSchedule":{
            "type":"string",
            "maxLength":8,
            "description":"Rate Schedule"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "billableCharge":{
            "type":"object",
            "properties":{
                "billableChargeId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Billable Charge ID"
                }
            }
        },
        "descriptionOnBill":{
            "type":"string",
            "maxLength":254,
            "description":"Description on Bill"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "calculationLines":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "headerSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Header Sequence"
                            },
                            "sequence":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Sequence"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code"
                            },
                            "characteristicValue":{
                                "type":"string",
                                "maxLength":16,
                                "description":"Characteristic Value"
                            },
                            "distributionCode":{
                                "type":"object",
                                "properties":{
                                    "distributionCode":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Distribution Code"
                                    }
                                }
                            },
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "timeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            },
                            "rcSequence":{
                                "type":"number",
                                "maximum":9999,
                                "minimum":-9999,
                                "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                                "example":"10"
                            },
                            "shouldPrint":{
                                "type":"boolean",
                                "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                "example":"true"
                            },
                            "shouldAppearInSummary":{
                                "type":"boolean",
                                "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                "example":"true"
                            },
                            "calculatedAmount":{
                                "type":"number",
                                "description":"Calculated Amount"
                            },
                            "exemptAmount":{
                                "type":"number",
                                "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                                "example":"$0.00"
                            },
                            "baseAmount":{
                                "type":"number",
                                "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                                "example":"$102.71"
                            },
                            "serviceQuantityIdentifier":{
                                "type":"string",
                                "maxLength":30,
                                "description":"SQI"
                            },
                            "billableServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Billable Service Quantity"
                            },
                            "measuresPeakQuantity":{
                                "type":"boolean",
                                "description":"Measures Peak Qty"
                            },
                            "descriptionOnBill":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Description on Bill"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "distributionDescription":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Distribution Code Description"
                            },
                            "isCharacteristicExist":{
                                "type":"boolean",
                                "description":"Characteristic exists",
                                "example":"false"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : billableCharge

Type: object

Show Source

• billableChargeId: string
  Maximum Length: 12

  Billable Charge ID

{
    "type":"object",
    "properties":{
        "billableChargeId":{
            "type":"string",
            "maxLength":12,
            "description":"Billable Charge ID"
        }
    }
}

Nested Schema : calculationLines

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "headerSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Header Sequence"
                    },
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Sequence"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            }
                        }
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code"
                    },
                    "characteristicValue":{
                        "type":"string",
                        "maxLength":16,
                        "description":"Characteristic Value"
                    },
                    "distributionCode":{
                        "type":"object",
                        "properties":{
                            "distributionCode":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Distribution Code"
                            }
                        }
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "rcSequence":{
                        "type":"number",
                        "maximum":9999,
                        "minimum":-9999,
                        "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                        "example":"10"
                    },
                    "shouldPrint":{
                        "type":"boolean",
                        "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                        "example":"true"
                    },
                    "shouldAppearInSummary":{
                        "type":"boolean",
                        "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                        "example":"true"
                    },
                    "calculatedAmount":{
                        "type":"number",
                        "description":"Calculated Amount"
                    },
                    "exemptAmount":{
                        "type":"number",
                        "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                        "example":"$0.00"
                    },
                    "baseAmount":{
                        "type":"number",
                        "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                        "example":"$102.71"
                    },
                    "serviceQuantityIdentifier":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI"
                    },
                    "billableServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Billable Service Quantity"
                    },
                    "measuresPeakQuantity":{
                        "type":"boolean",
                        "description":"Measures Peak Qty"
                    },
                    "descriptionOnBill":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Description on Bill"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "distributionDescription":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Distribution Code Description"
                    },
                    "isCharacteristicExist":{
                        "type":"boolean",
                        "description":"Characteristic exists",
                        "example":"false"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "headerSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Header Sequence"
            },
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Sequence"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    }
                }
            },
            "currency":{
                "type":"string",
                "maxLength":3,
                "description":"Currency Code"
            },
            "characteristicValue":{
                "type":"string",
                "maxLength":16,
                "description":"Characteristic Value"
            },
            "distributionCode":{
                "type":"object",
                "properties":{
                    "distributionCode":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Distribution Code"
                    }
                }
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use"
            },
            "rcSequence":{
                "type":"number",
                "maximum":9999,
                "minimum":-9999,
                "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                "example":"10"
            },
            "shouldPrint":{
                "type":"boolean",
                "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                "example":"true"
            },
            "shouldAppearInSummary":{
                "type":"boolean",
                "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                "example":"true"
            },
            "calculatedAmount":{
                "type":"number",
                "description":"Calculated Amount"
            },
            "exemptAmount":{
                "type":"number",
                "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                "example":"$0.00"
            },
            "baseAmount":{
                "type":"number",
                "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                "example":"$102.71"
            },
            "serviceQuantityIdentifier":{
                "type":"string",
                "maxLength":30,
                "description":"SQI"
            },
            "billableServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Billable Service Quantity"
            },
            "measuresPeakQuantity":{
                "type":"boolean",
                "description":"Measures Peak Qty"
            },
            "descriptionOnBill":{
                "type":"string",
                "maxLength":254,
                "description":"Description on Bill"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "distributionDescription":{
                "type":"string",
                "maxLength":30,
                "description":"Distribution Code Description"
            },
            "isCharacteristicExist":{
                "type":"boolean",
                "description":"Characteristic exists",
                "example":"false"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• baseAmount: number
  Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.

  Example: $102.71
• billableServiceQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Billable Service Quantity
• calculatedAmount: number
  Calculated Amount
• characteristicType: object characteristicType
• characteristicValue: string
  Maximum Length: 16

  Characteristic Value
• currency: string
  Maximum Length: 3

  Currency Code
• descriptionOnBill: string
  Maximum Length: 254

  Description on Bill
• distributionCode: object distributionCode
• distributionDescription: string
  Maximum Length: 30

  Distribution Code Description
• exemptAmount: number
  Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.

  Example: $0.00
• headerSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Header Sequence
• isCharacteristicExist: boolean
  Characteristic exists

  Example: false
• measuresPeakQuantity: boolean
  Measures Peak Qty
• rcSequence: number
  Minimum Value: -9999

  Maximum Value: 9999

  Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.

  Example: 10
• sequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Sequence
• serviceQuantityIdentifier: string
  Maximum Length: 30

  SQI
• shouldAppearInSummary: boolean
  The Appears in Summary switch defines if this line's amount also appears on a summary line.

  Example: true
• shouldPrint: boolean
  The Print switch controls whether information about this line will print on the customer's bill.

  Example: true
• timeOfUse: string
  Maximum Length: 30

  Time of Use
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "headerSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Header Sequence"
        },
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "characteristicValue":{
            "type":"string",
            "maxLength":16,
            "description":"Characteristic Value"
        },
        "distributionCode":{
            "type":"object",
            "properties":{
                "distributionCode":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Distribution Code"
                }
            }
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "rcSequence":{
            "type":"number",
            "maximum":9999,
            "minimum":-9999,
            "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
            "example":"10"
        },
        "shouldPrint":{
            "type":"boolean",
            "description":"The Print switch controls whether information about this line will print on the customer's bill.",
            "example":"true"
        },
        "shouldAppearInSummary":{
            "type":"boolean",
            "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
            "example":"true"
        },
        "calculatedAmount":{
            "type":"number",
            "description":"Calculated Amount"
        },
        "exemptAmount":{
            "type":"number",
            "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
            "example":"$0.00"
        },
        "baseAmount":{
            "type":"number",
            "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
            "example":"$102.71"
        },
        "serviceQuantityIdentifier":{
            "type":"string",
            "maxLength":30,
            "description":"SQI"
        },
        "billableServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Billable Service Quantity"
        },
        "measuresPeakQuantity":{
            "type":"boolean",
            "description":"Measures Peak Qty"
        },
        "descriptionOnBill":{
            "type":"string",
            "maxLength":254,
            "description":"Description on Bill"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "distributionDescription":{
            "type":"string",
            "maxLength":30,
            "description":"Distribution Code Description"
        },
        "isCharacteristicExist":{
            "type":"boolean",
            "description":"Characteristic exists",
            "example":"false"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• characteristicType: string
  Maximum Length: 8

  Characteristic Type

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

Nested Schema : distributionCode

Type: object

Show Source

• distributionCode: string
  Maximum Length: 10

  Distribution Code

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

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "financialTransactionId":{
                "type":"string",
                "maxLength":12,
                "description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).",
                "example":"211166656266"
            },
            "financialTransactionType":{
                "type":"string",
                "enum":[
                    "AD  ",
                    "AX  ",
                    "BS  ",
                    "BX  ",
                    "PS  ",
                    "PX  "
                ],
                "description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation",
                "example":"BS"
            },
            "financialTransactionTypeDescription":{
                "type":"string",
                "maxLength":150,
                "description":"FT Type Description"
            },
            "currentAmount":{
                "type":"number",
                "description":"Current Amount"
            },
            "accountingDate":{
                "type":"string",
                "format":"date",
                "description":"Accounting Date"
            },
            "arrearsDate":{
                "type":"string",
                "format":"date",
                "description":"Arrears Date is the date the FT starts aging.",
                "example":"03-04-2013"
            },
            "shouldShowOnBill":{
                "type":"boolean",
                "description":"Show on bill indicates if information about the FT appears on the customer's bill.",
                "example":"true"
            },
            "_data":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "sequence":{
                            "type":"number",
                            "maximum":999,
                            "minimum":-999,
                            "description":"Sequence"
                        },
                        "distributionCode":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Distribution Code"
                        },
                        "characteristicType":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Characteristic Type"
                        },
                        "characteristicValue":{
                            "type":"string",
                            "maxLength":16,
                            "description":"Characteristic Value"
                        },
                        "amount":{
                            "type":"number",
                            "description":"Amount defines the journal line's amount.",
                            "example":"$33.00"
                        },
                        "statistics":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                            "example":"CF"
                        },
                        "statisticAmount":{
                            "type":"number",
                            "maximum":1.0E13,
                            "minimum":-1.0E13,
                            "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                            "example":"0.000"
                        },
                        "isTotalAmount":{
                            "type":"boolean",
                            "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                            "example":"true"
                        },
                        "distributionDescription":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Distribution Code Description"
                        },
                        "version":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Version"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• _data: array _data
• accountingDate: string (date)
  Accounting Date
• arrearsDate: string (date)
  Arrears Date is the date the FT starts aging.

  Example: 03-04-2013
• currentAmount: number
  Current Amount
• financialTransactionId: string
  Maximum Length: 12

  FT ID is the system-assigned unique identifier of the financial transaction (FT).

  Example: 211166656266
• financialTransactionType: string
  Allowed Values: [ "AD ", "AX ", "BS ", "BX ", "PS ", "PX " ]

  Financial Transaction Type: AD - Adjustment, AX - Adjustment Cancellation, BS - Bill Segment, BX - Bill Segment Cancellation, PS - Pay Segment, PX - Pay Segment Cancellation * `AD ` - Adjustment, * `AX ` - Adjustment Cancellation, * `BS ` - Bill Segment, * `BX ` - Bill Segment Cancellation, * `PS ` - Pay Segment, * `PX ` - Pay Segment Cancellation

  Example: BS
• financialTransactionTypeDescription: string
  Maximum Length: 150

  FT Type Description
• shouldShowOnBill: boolean
  Show on bill indicates if information about the FT appears on the customer's bill.

  Example: true

{
    "type":"object",
    "properties":{
        "financialTransactionId":{
            "type":"string",
            "maxLength":12,
            "description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).",
            "example":"211166656266"
        },
        "financialTransactionType":{
            "type":"string",
            "enum":[
                "AD  ",
                "AX  ",
                "BS  ",
                "BX  ",
                "PS  ",
                "PX  "
            ],
            "description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation",
            "example":"BS"
        },
        "financialTransactionTypeDescription":{
            "type":"string",
            "maxLength":150,
            "description":"FT Type Description"
        },
        "currentAmount":{
            "type":"number",
            "description":"Current Amount"
        },
        "accountingDate":{
            "type":"string",
            "format":"date",
            "description":"Accounting Date"
        },
        "arrearsDate":{
            "type":"string",
            "format":"date",
            "description":"Arrears Date is the date the FT starts aging.",
            "example":"03-04-2013"
        },
        "shouldShowOnBill":{
            "type":"boolean",
            "description":"Show on bill indicates if information about the FT appears on the customer's bill.",
            "example":"true"
        },
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence"
                    },
                    "distributionCode":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Distribution Code"
                    },
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    },
                    "characteristicValue":{
                        "type":"string",
                        "maxLength":16,
                        "description":"Characteristic Value"
                    },
                    "amount":{
                        "type":"number",
                        "description":"Amount defines the journal line's amount.",
                        "example":"$33.00"
                    },
                    "statistics":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                        "example":"CF"
                    },
                    "statisticAmount":{
                        "type":"number",
                        "maximum":1.0E13,
                        "minimum":-1.0E13,
                        "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                        "example":"0.000"
                    },
                    "isTotalAmount":{
                        "type":"boolean",
                        "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                        "example":"true"
                    },
                    "distributionDescription":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Distribution Code Description"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence"
            },
            "distributionCode":{
                "type":"string",
                "maxLength":10,
                "description":"Distribution Code"
            },
            "characteristicType":{
                "type":"string",
                "maxLength":8,
                "description":"Characteristic Type"
            },
            "characteristicValue":{
                "type":"string",
                "maxLength":16,
                "description":"Characteristic Value"
            },
            "amount":{
                "type":"number",
                "description":"Amount defines the journal line's amount.",
                "example":"$33.00"
            },
            "statistics":{
                "type":"string",
                "maxLength":8,
                "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                "example":"CF"
            },
            "statisticAmount":{
                "type":"number",
                "maximum":1.0E13,
                "minimum":-1.0E13,
                "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                "example":"0.000"
            },
            "isTotalAmount":{
                "type":"boolean",
                "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                "example":"true"
            },
            "distributionDescription":{
                "type":"string",
                "maxLength":30,
                "description":"Distribution Code Description"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount: number
  Amount defines the journal line's amount.

  Example: $33.00
• characteristicType: string
  Maximum Length: 8

  Characteristic Type
• characteristicValue: string
  Maximum Length: 16

  Characteristic Value
• distributionCode: string
  Maximum Length: 10

  Distribution Code
• distributionDescription: string
  Maximum Length: 30

  Distribution Code Description
• isTotalAmount: boolean
  Total Amount defines if the journal line contains the total of the other journal lines.

  Example: true
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence
• statisticAmount: number
  Minimum Value: -1.0E13

  Maximum Value: 1.0E13

  Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.

  Example: 0.000
• statistics: string
  Maximum Length: 8

  Statistics Code is only specified when a statistical quantity is associated with the distribution line.

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

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence"
        },
        "distributionCode":{
            "type":"string",
            "maxLength":10,
            "description":"Distribution Code"
        },
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        },
        "characteristicValue":{
            "type":"string",
            "maxLength":16,
            "description":"Characteristic Value"
        },
        "amount":{
            "type":"number",
            "description":"Amount defines the journal line's amount.",
            "example":"$33.00"
        },
        "statistics":{
            "type":"string",
            "maxLength":8,
            "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
            "example":"CF"
        },
        "statisticAmount":{
            "type":"number",
            "maximum":1.0E13,
            "minimum":-1.0E13,
            "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
            "example":"0.000"
        },
        "isTotalAmount":{
            "type":"boolean",
            "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
            "example":"true"
        },
        "distributionDescription":{
            "type":"string",
            "maxLength":30,
            "description":"Distribution Code Description"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Sequence"
            },
            "itemType":{
                "type":"string",
                "maxLength":30,
                "description":"Item Type is the type of item.",
                "example":"Generic Current Transformer"
            },
            "item":{
                "type":"object",
                "properties":{
                    "item":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Item ID"
                    }
                }
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"Start Date"
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"End Date"
            },
            "itemCount":{
                "type":"number",
                "maximum":9.9999999999E8,
                "minimum":-9.9999999999E8,
                "description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.",
                "example":"1.00"
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "dailyServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Daily Service Quantity is the item's estimated amount of daily consumption.",
                "example":"470.762600"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dailyServiceQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Daily Service Quantity is the item's estimated amount of daily consumption.

  Example: 470.762600
• endDate: string (date)
  End Date
• item: object item
• itemCount: number
  Minimum Value: -9.9999999999E8

  Maximum Value: 9.9999999999E8

  Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.

  Example: 1.00
• itemType: string
  Maximum Length: 30

  Item Type is the type of item.

  Example: Generic Current Transformer
• sequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Sequence
• startDate: string (date)
  Start Date
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence"
        },
        "itemType":{
            "type":"string",
            "maxLength":30,
            "description":"Item Type is the type of item.",
            "example":"Generic Current Transformer"
        },
        "item":{
            "type":"object",
            "properties":{
                "item":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Item ID"
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date"
        },
        "itemCount":{
            "type":"number",
            "maximum":9.9999999999E8,
            "minimum":-9.9999999999E8,
            "description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.",
            "example":"1.00"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "dailyServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Daily Service Quantity is the item's estimated amount of daily consumption.",
            "example":"470.762600"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : item

Type: object

Show Source

• item: string
  Maximum Length: 10

  Item ID

{
    "type":"object",
    "properties":{
        "item":{
            "type":"string",
            "maxLength":10,
            "description":"Item ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "billMessageCode":{
                "type":"string",
                "maxLength":4,
                "description":"Bill Message"
            },
            "insert":{
                "type":"string",
                "maxLength":8,
                "description":"Insert Code defines if the bill message causes an insert in the envelope."
            },
            "messagePriority":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "40  ",
                    "50  ",
                    "60  ",
                    "70  ",
                    "80  ",
                    "90  "
                ],
                "description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest",
                "example":"20"
            },
            "messageOnBill":{
                "type":"string",
                "maxLength":254,
                "description":"Message On Bill is the message associated with the code.",
                "example":"Electric service not billed"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billMessageCode: string
  Maximum Length: 4

  Bill Message
• insert: string
  Maximum Length: 8

  Insert Code defines if the bill message causes an insert in the envelope.
• messageOnBill: string
  Maximum Length: 254

  Message On Bill is the message associated with the code.

  Example: Electric service not billed
• messagePriority: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "90 " ]

  Priority is the bill messages priority (on the printed bill). * `10 ` - Priority 10 -- Lowest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `90 ` - Priority 90 -- Highest

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

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "billMessageCode":{
            "type":"string",
            "maxLength":4,
            "description":"Bill Message"
        },
        "insert":{
            "type":"string",
            "maxLength":8,
            "description":"Insert Code defines if the bill message causes an insert in the envelope."
        },
        "messagePriority":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  ",
                "80  ",
                "90  "
            ],
            "description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest",
            "example":"20"
        },
        "messageOnBill":{
            "type":"string",
            "maxLength":254,
            "description":"Message On Bill is the message associated with the code.",
            "example":"Electric service not billed"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• action: string
  Allowed Values: [ "C1CF", "C1CO", "C1CR", "C1DE", "C1FR", "C1GN", "C1RO" ]

  Bill Web Service Actions: * `C1CF` - Cancel Frozen, * `C1CO` - Complete, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1RO` - ReOpen

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "C1CF",
                "C1CO",
                "C1CR",
                "C1DE",
                "C1FR",
                "C1GN",
                "C1RO"
            ],
            "description":"Bill Web Service Actions:\n* `C1CF` - Cancel Frozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "finalUnitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.",
                "example":"CF"
            },
            "finalTimeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Final Time of Use is the final time-of-use code of the calculation / audit read.",
                "example":"ON"
            },
            "finalServiceQuantityId":{
                "type":"string",
                "maxLength":30,
                "description":"Final SQI is the final service quantity identifier of the calculation / audit read.",
                "example":"DAMT"
            },
            "registerQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.",
                "example":"200.000000"
            },
            "servicePointId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID"
            },
            "meterConfigurationId":{
                "type":"string",
                "maxLength":10,
                "description":"Meter Configuration ID"
            },
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Sequence"
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use"
            },
            "serviceQuantityIdentifier":{
                "type":"string",
                "maxLength":30,
                "description":"SQI"
            },
            "startRegisterReading":{
                "type":"number",
                "maximum":9.99999999999999E8,
                "minimum":-9.99999999999999E8,
                "description":"Start Register Reading is the start register reading.",
                "example":"7201.000000"
            },
            "endRegisterReading":{
                "type":"number",
                "maximum":9.99999999999999E8,
                "minimum":-9.99999999999999E8,
                "description":"End Register Reading is the end register reading.",
                "example":"11578.000000"
            },
            "measuredQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive",
                "example":"4377.000000"
            },
            "registerConstant":{
                "type":"number",
                "maximum":999999.999999,
                "minimum":-999999.999999,
                "description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.",
                "example":"1.000000"
            },
            "howToUse":{
                "type":"string",
                "enum":[
                    "+   ",
                    "-   ",
                    "C   ",
                    "P   "
                ],
                "description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak",
                "example":"+"
            },
            "howToUseRead":{
                "type":"string",
                "enum":[
                    "+   ",
                    "-   ",
                    "C   ",
                    "S   ",
                    "X   "
                ],
                "description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit",
                "example":"+"
            },
            "usePercent":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Use Percent is the percentage of the total consumption that was billed.",
                "example":"100"
            },
            "measuresPeakQuantity":{
                "type":"boolean",
                "description":"Measures Peak Qty"
            },
            "startReadDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Start Read Date/Time is the date and time of the start meter read.",
                "example":"1998-06-30T00:00:00-04:00"
            },
            "endReadDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"End Read Date/Time is the date and time of the end meter read.",
                "example":"998-09-30T00:00:00-04:00"
            },
            "startRegisterReadId":{
                "type":"string",
                "maxLength":12,
                "description":"Start Register Read ID is the unique identifier of the start register read.",
                "example":"444074862768"
            },
            "endRegisterReadingId":{
                "type":"string",
                "maxLength":12,
                "description":"End Register Read ID is the unique identifier of the end register read.",
                "example":"444074849655"
            },
            "startRegisterReadTypeDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Start Register Read Type Description"
            },
            "endRegisterReadTypeDescription":{
                "type":"string",
                "maxLength":150,
                "description":"End Register Read Type Description"
            },
            "multiplier":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
                "example":"1.000000"
            },
            "consumptionType":{
                "type":"string",
                "enum":[
                    "C   ",
                    "S   "
                ],
                "description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive",
                "example":"S"
            },
            "notAvailableConsumptionDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Not Available Consumption Description"
            },
            "startMeterRead":{
                "type":"string",
                "maxLength":12,
                "description":"Start meter read ID",
                "example":"444074813104"
            },
            "endMeterRead":{
                "type":"string",
                "maxLength":12,
                "description":"End meter read ID",
                "example":"44074866808"
            },
            "meterReadId":{
                "type":"string",
                "maxLength":12,
                "description":"Meter Read ID",
                "example":"8833057699"
            },
            "unitOfMeasure2":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "serviceQuantityIdentifier2":{
                "type":"string",
                "maxLength":30,
                "description":"Service Quantity Identifier"
            },
            "timeOfUse2":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use"
            },
            "finalUomDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Final Uom Description"
            },
            "finalSqiDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Final SQI Description"
            },
            "finalTouDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Final TOU Description"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• consumptionType: string
  Allowed Values: [ "C ", "S " ]

  Consumptive/Subtractive flag shows if the register is consumptive or subtractive. * `C ` - Consumptive, * `S ` - Subtractive

  Example: S
• endMeterRead: string
  Maximum Length: 12

  End meter read ID

  Example: 44074866808
• endReadDateTime: string (date-time)
  End Read Date/Time is the date and time of the end meter read.

  Example: 998-09-30T00:00:00-04:00
• endRegisterReading: number
  Minimum Value: -9.99999999999999E8

  Maximum Value: 9.99999999999999E8

  End Register Reading is the end register reading.

  Example: 11578.000000
• endRegisterReadingId: string
  Maximum Length: 12

  End Register Read ID is the unique identifier of the end register read.

  Example: 444074849655
• endRegisterReadTypeDescription: string
  Maximum Length: 150

  End Register Read Type Description
• finalServiceQuantityId: string
  Maximum Length: 30

  Final SQI is the final service quantity identifier of the calculation / audit read.

  Example: DAMT
• finalSqiDescription: string
  Maximum Length: 150

  Final SQI Description
• finalTimeOfUse: string
  Maximum Length: 30

  Final Time of Use is the final time-of-use code of the calculation / audit read.

  Example: ON
• finalTouDescription: string
  Maximum Length: 150

  Final TOU Description
• finalUnitOfMeasure: string
  Maximum Length: 30

  Final Unit of Measure is the final unit of measure of the calculation / audit read.

  Example: CF
• finalUomDescription: string
  Maximum Length: 150

  Final Uom Description
• howToUse: string
  Allowed Values: [ "+ ", "- ", "C ", "P " ]

  How To Use is a code that indicates if the "calculation / audit" read was is considered to be additive, subtractive, peak or check. * `+ ` - Additive, * `- ` - Subtractive, * `C ` - Check, * `P ` - Peak

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

  How To Use (SP) is the SA/SP's how to use code. * `+ ` - Add, * `- ` - Subtract, * `C ` - Check, * `S ` - Service Quantity, * `X ` - Calculation/Audit

  Example: +
• measuredQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive

  Example: 4377.000000
• measuresPeakQuantity: boolean
  Measures Peak Qty
• meterConfigurationId: string
  Maximum Length: 10

  Meter Configuration ID
• meterReadId: string
  Maximum Length: 12

  Meter Read ID

  Example: 8833057699
• multiplier: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.

  Example: 1.000000
• notAvailableConsumptionDescription: string
  Maximum Length: 150

  Not Available Consumption Description
• registerConstant: number
  Minimum Value: -999999.999999

  Maximum Value: 999999.999999

  Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.

  Example: 1.000000
• registerQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.

  Example: 200.000000
• sequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Sequence
• servicePointId: string
  Maximum Length: 10

  Service Point ID
• serviceQuantityIdentifier: string
  Maximum Length: 30

  SQI
• serviceQuantityIdentifier2: string
  Maximum Length: 30

  Service Quantity Identifier
• startMeterRead: string
  Maximum Length: 12

  Start meter read ID

  Example: 444074813104
• startReadDateTime: string (date-time)
  Start Read Date/Time is the date and time of the start meter read.

  Example: 1998-06-30T00:00:00-04:00
• startRegisterReadId: string
  Maximum Length: 12

  Start Register Read ID is the unique identifier of the start register read.

  Example: 444074862768
• startRegisterReading: number
  Minimum Value: -9.99999999999999E8

  Maximum Value: 9.99999999999999E8

  Start Register Reading is the start register reading.

  Example: 7201.000000
• startRegisterReadTypeDescription: string
  Maximum Length: 150

  Start Register Read Type Description
• timeOfUse: string
  Maximum Length: 30

  Time of Use
• timeOfUse2: string
  Maximum Length: 30

  Time of Use
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure
• unitOfMeasure2: string
  Maximum Length: 30

  Unit of Measure
• usePercent: number
  Minimum Value: -999

  Maximum Value: 999

  Use Percent is the percentage of the total consumption that was billed.

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

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "finalUnitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.",
            "example":"CF"
        },
        "finalTimeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Final Time of Use is the final time-of-use code of the calculation / audit read.",
            "example":"ON"
        },
        "finalServiceQuantityId":{
            "type":"string",
            "maxLength":30,
            "description":"Final SQI is the final service quantity identifier of the calculation / audit read.",
            "example":"DAMT"
        },
        "registerQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.",
            "example":"200.000000"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        },
        "meterConfigurationId":{
            "type":"string",
            "maxLength":10,
            "description":"Meter Configuration ID"
        },
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "serviceQuantityIdentifier":{
            "type":"string",
            "maxLength":30,
            "description":"SQI"
        },
        "startRegisterReading":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":-9.99999999999999E8,
            "description":"Start Register Reading is the start register reading.",
            "example":"7201.000000"
        },
        "endRegisterReading":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":-9.99999999999999E8,
            "description":"End Register Reading is the end register reading.",
            "example":"11578.000000"
        },
        "measuredQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive",
            "example":"4377.000000"
        },
        "registerConstant":{
            "type":"number",
            "maximum":999999.999999,
            "minimum":-999999.999999,
            "description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.",
            "example":"1.000000"
        },
        "howToUse":{
            "type":"string",
            "enum":[
                "+   ",
                "-   ",
                "C   ",
                "P   "
            ],
            "description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak",
            "example":"+"
        },
        "howToUseRead":{
            "type":"string",
            "enum":[
                "+   ",
                "-   ",
                "C   ",
                "S   ",
                "X   "
            ],
            "description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit",
            "example":"+"
        },
        "usePercent":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Use Percent is the percentage of the total consumption that was billed.",
            "example":"100"
        },
        "measuresPeakQuantity":{
            "type":"boolean",
            "description":"Measures Peak Qty"
        },
        "startReadDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start Read Date/Time is the date and time of the start meter read.",
            "example":"1998-06-30T00:00:00-04:00"
        },
        "endReadDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"End Read Date/Time is the date and time of the end meter read.",
            "example":"998-09-30T00:00:00-04:00"
        },
        "startRegisterReadId":{
            "type":"string",
            "maxLength":12,
            "description":"Start Register Read ID is the unique identifier of the start register read.",
            "example":"444074862768"
        },
        "endRegisterReadingId":{
            "type":"string",
            "maxLength":12,
            "description":"End Register Read ID is the unique identifier of the end register read.",
            "example":"444074849655"
        },
        "startRegisterReadTypeDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Start Register Read Type Description"
        },
        "endRegisterReadTypeDescription":{
            "type":"string",
            "maxLength":150,
            "description":"End Register Read Type Description"
        },
        "multiplier":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
            "example":"1.000000"
        },
        "consumptionType":{
            "type":"string",
            "enum":[
                "C   ",
                "S   "
            ],
            "description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive",
            "example":"S"
        },
        "notAvailableConsumptionDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Not Available Consumption Description"
        },
        "startMeterRead":{
            "type":"string",
            "maxLength":12,
            "description":"Start meter read ID",
            "example":"444074813104"
        },
        "endMeterRead":{
            "type":"string",
            "maxLength":12,
            "description":"End meter read ID",
            "example":"44074866808"
        },
        "meterReadId":{
            "type":"string",
            "maxLength":12,
            "description":"Meter Read ID",
            "example":"8833057699"
        },
        "unitOfMeasure2":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "serviceQuantityIdentifier2":{
            "type":"string",
            "maxLength":30,
            "description":"Service Quantity Identifier"
        },
        "timeOfUse2":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "finalUomDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Final Uom Description"
        },
        "finalSqiDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Final SQI Description"
        },
        "finalTouDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Final TOU Description"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use"
            },
            "serviceQuantityIdentifier":{
                "type":"string",
                "maxLength":30,
                "description":"SQI"
            },
            "initialServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
                "example":"470.762600"
            },
            "billableServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Billable Service Quantity"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billableServiceQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Billable Service Quantity
• initialServiceQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.

  Example: 470.762600
• serviceQuantityIdentifier: string
  Maximum Length: 30

  SQI
• timeOfUse: string
  Maximum Length: 30

  Time of Use
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "serviceQuantityIdentifier":{
            "type":"string",
            "maxLength":30,
            "description":"SQI"
        },
        "initialServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
            "example":"470.762600"
        },
        "billableServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Billable Service Quantity"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "currentAmount":{
                "type":"number",
                "description":"Current Amount"
            },
            "billSegmentStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "40  ",
                    "50  ",
                    "60  ",
                    "70  "
                ],
                "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billSegmentStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]

  Bill Segment Status: * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `40 ` - Pending Cancel, * `50 ` - Frozen, * `60 ` - Canceled, * `70 ` - OK
• currentAmount: number
  Current Amount

{
    "type":"object",
    "properties":{
        "currentAmount":{
            "type":"number",
            "description":"Current Amount"
        },
        "billSegmentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1-BillSegm

Type: object

Show Source

• _self: string
  _self
• account: object account
• accountingDate: string (date)
  Accounting Date
• areEstimatesAllowed: boolean
  Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.

  Example: false
• bill: object bill
• billCycle: object billCycle
  Bill Cycle displays the bill cycle and window start date of the bill segment's bill.
• billScenarioId: string
  Maximum Length: 12

  Billing Scenario ID allows you to go to the proposal SA's billing scenario where you can tinker with consumption and the bill segment period used to generate this bill segment.
• billSegmentId: string
  Maximum Length: 12

  Bill Segment ID is the system-assigned unique identifier of the bill segment.

  Example: 211366855400
• billSegmentPeriod: string
  Maximum Length: 30

  Bill Segment Period is the start and end dates of the bill segment.

  Example: 11-04-2013 12-03-2013
• billSegmentStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]

  Bill Segment Status: * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `40 ` - Pending Cancel, * `50 ` - Frozen, * `60 ` - Canceled, * `70 ` - OK
• billSegmentStatusDescription: string
  Maximum Length: 150

  Description for bill segment's status.

  Example: Freezable
• billStatus: string
  Allowed Values: [ "C ", "P " ]

  Bill Status is the bill's status. * `C ` - Complete, * `P ` - Pending

  Example: C
• calcLines: object calcLines
• canActionRegenerate: boolean
  Regenerate action regenerated the bill segment after correcting the cause of the problem for errored bill segment.

  Example: false
• canCancel: boolean
  The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.

  Example: true
• cancelBillSegmentId: string
  Maximum Length: 12

  If the bill segment was canceled and rebilled by another segment, a reference to the new bill segment is displayed. Cancel Bill Segment ID refers to the new bill segment id that superseded the canceled segment.

  Example: 661660087111
• cancelReason: object cancelReason
  Cancel Reason defines why the bill segment(s) are being canceled.
• cancelReasonDescription: string
  Maximum Length: 100

  Cancel Reason Description defines the reason why the bill segment(s) are being canceled.

  Example: Canceled prior to completion.
• canDelete: boolean
  The Delete is used to delete one or more bill segments.

  Example: false
• canFreeze: boolean
  The Freeze is used to freeze one or more bill segments.
• canGenerate: boolean
  The Generate is used to delete and recreate one or more bill segments.

  Example: false
• canInitCancel: boolean
  Initialize Cancel causes the first step of the bill segment cancellation process to be executed. You'd click this button if a frozen bill segment should never have been created (i.e., you want to remove the financial impact of a bill segment from a customer's balance). This button is enabled when you display a Frozen bill segment AND the bill segment's bill is not written off.

  Example: false
• canShowAccountingDate: boolean
  Accounting Date is the date the system uses to determine the financial transaction's accounting period in your general ledger.

  Example: 06-05-2013
• canUndo: boolean
  Undo returns a Pending Cancel bill segment to the Frozen state.

  Example: false
• canUseOldReadsItemsServiceQuantity: boolean
  Check Use Old Read/Item/SQ if the system is configured to use the consumption details used on the original bill segments.

  Example: false
• correctionNote: string
  Maximum Length: 150

  The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.
• creationDateTime: string (date-time)
  Create Date/Time is the date and time on which the bill was originally created.

  Example: 2001-05-16
• creditDate: string (date)
  Bill Date is the business date that was used when the bill was completed.

  Example: 06-05-2013
• creditNote: string
  Maximum Length: 12

  The Credit Note is used to cancel selected bill segments and create a new bill that contains the cancellation details. We refer to this "negative bill" as a credit note.
• currency: object currency
• currentAmount: number
  Current Amount is the bill segment's effect on the service agreement's current balance.

  Example: $405.52
• cutOffDate: string (date)
  Cutoff Date is the last day of the new bill segment.

  Example: 2021-10-05
• exception: object exception
• financialDetails: object financialDetails
• hasBillingOption: boolean
  Billing Option
• hasServiceQuantityOverride: boolean
  SQ Override
• httpMethod: string
  Allowed Values: [ "DELT", "GET ", "POST", "PTCH", "PUT " ]

  HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put

  Example: GET
• isClosingBillSegment: boolean
  If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).

  Example: true
• isCorrectionNote: boolean
  The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.

  Example: false
• isCreditNote: boolean
  Credit Note is used to cancel ALL bill segments and create a new bill that contains the cancellation details.

  Example: false
• isEstimate: boolean
  If the Estimate switch is on, consumption on this bill segment has been estimated by the system.

  Example: true
• isItemOverride: boolean
  Item Override
• items: object items
• masterBillSegmentId: string
  Maximum Length: 12

  Master Bseg ID shows the unique identifier of the master bill segment whose bill triggered the creation of this sub service agreement.

  Example: 661660087111
• messages: object messages
• nextActions: array nextActions
• payoffAmount: number
  Payoff Amount is only shown if it differs from current amount.

  Example: $33.20
• periodEndDate: string (date)
  End Date
• periodStartDate: string (date)
  Start Date
• premise: object premise
• processDate: string (date)
  Process Date
• quote: object quote
• quoteDetailId: string
  Maximum Length: 12

  Quote Detail ID is the system-assigned unique identifier of the quote detail.
• readDetails: object readDetails
• saRelationshipId: string
  Maximum Length: 10

  SA Relationship ID shows the unique identifier of the record that defines the relationship between the sub service agreement and the master service agreement (this record shows the service provider associated with the bill segment).
• serviceAgreement: object serviceAgreement
  SA ID contains information about the bill segment's service agreement.
• serviceQuantities: object serviceQuantities
• shouldRebill: boolean
  The Rebill causes an existing bill segment to be canceled, and a new bill segment to be created.

  Example: true
• specialUsage: string
  Allowed Values: [ "PROP" ]

  Special Usage flag shows if it's a proposal SA. * `PROP` - Proposal SA

  Example: PROP
• statusChangeDateTime: string (date-time)
  Bill Segment's status change date/time

  Example: 06-05-2013 04:28PM
• subBillSegments: object subBillSegments
• usageEndDateTime: string (date-time)
  Usage end date is the last date for bill segment used by meter data management system.

  Example: 03-04-2013
• usagePeriod: string
  Maximum Length: 1

  Usage Period is the period used by the meter data management system to determine the correct interval data to process for the bill segment.

  Example: 11-04-2013 12-03-2013
• usageStartDateTime: string (date-time)
  Usage start date is the first day for bill segment used by meter data management system.

  Example: 03-04-2013
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version
• windowStartDate: string (date)
  Window Start Date

  Example: 12-03-2013

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put",
            "example":"GET"
        },
        "billSegmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.",
            "example":"211366855400"
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID identifies the customer who is responsible for the bill.",
                    "example":"1112345900"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "currentAmount":{
            "type":"number",
            "description":"Current Amount is the bill segment's effect on the service agreement's current balance.",
            "example":"$405.52"
        },
        "payoffAmount":{
            "type":"number",
            "description":"Payoff Amount is only shown if it differs from current amount.",
            "example":"$33.20"
        },
        "bill":{
            "type":"object",
            "properties":{
                "billId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
                    "example":"211122345678"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "serviceAgreement":{
            "type":"object",
            "description":"SA ID contains information about the bill segment's service agreement.",
            "properties":{
                "serviceAgreement":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "periodStartDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date"
        },
        "periodEndDate":{
            "type":"string",
            "format":"date",
            "description":"End Date"
        },
        "usageStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Usage start date is the first day for bill segment used by meter data management system.",
            "example":"03-04-2013"
        },
        "usageEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Usage end date is the last date for bill segment used by meter data management system.",
            "example":"03-04-2013"
        },
        "billSegmentPeriod":{
            "type":"string",
            "maxLength":30,
            "description":"Bill Segment Period is the start and end dates of the bill segment.",
            "example":"11-04-2013 12-03-2013"
        },
        "usagePeriod":{
            "type":"string",
            "maxLength":1,
            "description":"Usage Period is the period used by the meter data management system to determine the correct interval data to process for the bill segment.",
            "example":"11-04-2013 12-03-2013"
        },
        "billCycle":{
            "type":"object",
            "description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.",
            "properties":{
                "billCycle":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.",
                    "example":"M-D2 (Monthly bill cycle - day 2)"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "billStatus":{
            "type":"string",
            "enum":[
                "C   ",
                "P   "
            ],
            "description":"Bill Status is the bill's status.\n* `C   ` - Complete,\n* `P   ` - Pending",
            "example":"C"
        },
        "isEstimate":{
            "type":"boolean",
            "description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.",
            "example":"true"
        },
        "isClosingBillSegment":{
            "type":"boolean",
            "description":"If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).",
            "example":"true"
        },
        "hasServiceQuantityOverride":{
            "type":"boolean",
            "description":"SQ Override"
        },
        "isItemOverride":{
            "type":"boolean",
            "description":"Item Override"
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time is the date and time on which the bill was originally created.",
            "example":"2001-05-16"
        },
        "saRelationshipId":{
            "type":"string",
            "maxLength":10,
            "description":"SA Relationship ID shows the unique identifier of the record that defines the relationship between the sub service agreement and the master service agreement (this record shows the service provider associated with the bill segment)."
        },
        "billSegmentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
        },
        "billSegmentStatusDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Description for bill segment's status.",
            "example":"Freezable"
        },
        "statusChangeDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Bill Segment's status change date/time",
            "example":"06-05-2013 04:28PM"
        },
        "cancelReasonDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Cancel Reason Description defines the reason why the bill segment(s) are being canceled.",
            "example":"Canceled prior to completion."
        },
        "quote":{
            "type":"object",
            "properties":{
                "quoteId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Quote ID is the system-assigned unique identifier of the quote."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "cutOffDate":{
            "type":"string",
            "format":"date",
            "description":"Cutoff Date is the last day of the new bill segment.",
            "example":"2021-10-05"
        },
        "accountingDate":{
            "type":"string",
            "format":"date",
            "description":"Accounting Date"
        },
        "cancelReason":{
            "type":"object",
            "description":"Cancel Reason defines why the bill segment(s) are being canceled.",
            "properties":{
                "cancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Cancel Reason defines why the bill segment(s) are being canceled.",
                    "example":"Wrong read"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "areEstimatesAllowed":{
            "type":"boolean",
            "description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.",
            "example":"false"
        },
        "hasBillingOption":{
            "type":"boolean",
            "description":"Billing Option"
        },
        "canUseOldReadsItemsServiceQuantity":{
            "type":"boolean",
            "description":"Check Use Old Read/Item/SQ if the system is configured to use the consumption details used on the original bill segments.",
            "example":"false"
        },
        "creditDate":{
            "type":"string",
            "format":"date",
            "description":"Bill Date is the business date that was used when the bill was completed.",
            "example":"06-05-2013"
        },
        "creditNote":{
            "type":"string",
            "maxLength":12,
            "description":"The Credit Note is used to cancel selected bill segments and create a new bill that contains the cancellation details. We refer to this \"negative bill\" as a credit note."
        },
        "correctionNote":{
            "type":"string",
            "maxLength":150,
            "description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details."
        },
        "canShowAccountingDate":{
            "type":"boolean",
            "description":"Accounting Date  is the date the system uses to determine the financial transaction's accounting period in your general ledger.",
            "example":"06-05-2013"
        },
        "processDate":{
            "type":"string",
            "format":"date",
            "description":"Process Date"
        },
        "specialUsage":{
            "type":"string",
            "enum":[
                "PROP"
            ],
            "description":"Special Usage flag shows if it's a proposal SA.\n* `PROP` - Proposal SA",
            "example":"PROP"
        },
        "currency":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "windowStartDate":{
            "type":"string",
            "format":"date",
            "description":"Window Start Date",
            "example":"12-03-2013"
        },
        "cancelBillSegmentId":{
            "type":"string",
            "maxLength":12,
            "description":"If the bill segment was canceled and rebilled by another segment, a reference to the new bill segment is displayed. Cancel Bill Segment ID refers to the new bill segment id that superseded the canceled segment.",
            "example":"661660087111"
        },
        "masterBillSegmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Master Bseg ID shows the unique identifier of the master bill segment whose bill triggered the creation of this sub service agreement.",
            "example":"661660087111"
        },
        "quoteDetailId":{
            "type":"string",
            "maxLength":12,
            "description":"Quote Detail ID is the system-assigned unique identifier of the quote detail."
        },
        "billScenarioId":{
            "type":"string",
            "maxLength":12,
            "description":"Billing Scenario ID allows you to go to the proposal SA's billing scenario where you can tinker with consumption and the bill segment period used to generate this bill segment."
        },
        "canCancel":{
            "type":"boolean",
            "description":"The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.",
            "example":"true"
        },
        "canDelete":{
            "type":"boolean",
            "description":"The Delete is used to delete one or more bill segments.",
            "example":"false"
        },
        "canFreeze":{
            "type":"boolean",
            "description":"The Freeze is used to freeze one or more bill segments."
        },
        "canGenerate":{
            "type":"boolean",
            "description":"The Generate is used to delete and recreate one or more bill segments.",
            "example":"false"
        },
        "canInitCancel":{
            "type":"boolean",
            "description":"Initialize  Cancel causes the first step of the bill segment cancellation process to be executed. You'd click this button if a frozen bill segment should never have been created (i.e., you want to remove the financial impact of a bill segment from a customer's balance).\n\nThis button is enabled when you display a Frozen bill segment AND the bill segment's bill is not written off.",
            "example":"false"
        },
        "shouldRebill":{
            "type":"boolean",
            "description":"The Rebill causes an existing bill segment to be canceled, and a new bill segment to be created.",
            "example":"true"
        },
        "canActionRegenerate":{
            "type":"boolean",
            "description":"Regenerate action regenerated the bill segment after correcting the cause of the problem for errored bill segment.",
            "example":"false"
        },
        "canUndo":{
            "type":"boolean",
            "description":"Undo returns a Pending Cancel bill segment to the Frozen state.",
            "example":"false"
        },
        "isCreditNote":{
            "type":"boolean",
            "description":"Credit Note is used to cancel ALL bill segments and create a new bill that contains the cancellation details.",
            "example":"false"
        },
        "isCorrectionNote":{
            "type":"boolean",
            "description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.",
            "example":"false"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "exception":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message category within Oracle Utilities Application Framework.",
                    "example":"0"
                },
                "messageNumber":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message number within Oracle Utilities Application Framework.",
                    "example":"0"
                },
                "expandedMessage":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Expanded Message exception"
                }
            }
        },
        "readDetails":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "finalUnitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.",
                                "example":"CF"
                            },
                            "finalTimeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Final Time of Use is the final time-of-use code of the calculation / audit read.",
                                "example":"ON"
                            },
                            "finalServiceQuantityId":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Final SQI is the final service quantity identifier of the calculation / audit read.",
                                "example":"DAMT"
                            },
                            "registerQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.",
                                "example":"200.000000"
                            },
                            "servicePointId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID"
                            },
                            "meterConfigurationId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Meter Configuration ID"
                            },
                            "sequence":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Sequence"
                            },
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "timeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            },
                            "serviceQuantityIdentifier":{
                                "type":"string",
                                "maxLength":30,
                                "description":"SQI"
                            },
                            "startRegisterReading":{
                                "type":"number",
                                "maximum":9.99999999999999E8,
                                "minimum":-9.99999999999999E8,
                                "description":"Start Register Reading is the start register reading.",
                                "example":"7201.000000"
                            },
                            "endRegisterReading":{
                                "type":"number",
                                "maximum":9.99999999999999E8,
                                "minimum":-9.99999999999999E8,
                                "description":"End Register Reading is the end register reading.",
                                "example":"11578.000000"
                            },
                            "measuredQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive",
                                "example":"4377.000000"
                            },
                            "registerConstant":{
                                "type":"number",
                                "maximum":999999.999999,
                                "minimum":-999999.999999,
                                "description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.",
                                "example":"1.000000"
                            },
                            "howToUse":{
                                "type":"string",
                                "enum":[
                                    "+   ",
                                    "-   ",
                                    "C   ",
                                    "P   "
                                ],
                                "description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak",
                                "example":"+"
                            },
                            "howToUseRead":{
                                "type":"string",
                                "enum":[
                                    "+   ",
                                    "-   ",
                                    "C   ",
                                    "S   ",
                                    "X   "
                                ],
                                "description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit",
                                "example":"+"
                            },
                            "usePercent":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Use Percent is the percentage of the total consumption that was billed.",
                                "example":"100"
                            },
                            "measuresPeakQuantity":{
                                "type":"boolean",
                                "description":"Measures Peak Qty"
                            },
                            "startReadDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Start Read Date/Time is the date and time of the start meter read.",
                                "example":"1998-06-30T00:00:00-04:00"
                            },
                            "endReadDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"End Read Date/Time is the date and time of the end meter read.",
                                "example":"998-09-30T00:00:00-04:00"
                            },
                            "startRegisterReadId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Start Register Read ID is the unique identifier of the start register read.",
                                "example":"444074862768"
                            },
                            "endRegisterReadingId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"End Register Read ID is the unique identifier of the end register read.",
                                "example":"444074849655"
                            },
                            "startRegisterReadTypeDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Start Register Read Type Description"
                            },
                            "endRegisterReadTypeDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"End Register Read Type Description"
                            },
                            "multiplier":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
                                "example":"1.000000"
                            },
                            "consumptionType":{
                                "type":"string",
                                "enum":[
                                    "C   ",
                                    "S   "
                                ],
                                "description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive",
                                "example":"S"
                            },
                            "notAvailableConsumptionDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Not Available Consumption Description"
                            },
                            "startMeterRead":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Start meter read ID",
                                "example":"444074813104"
                            },
                            "endMeterRead":{
                                "type":"string",
                                "maxLength":12,
                                "description":"End meter read ID",
                                "example":"44074866808"
                            },
                            "meterReadId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Meter Read ID",
                                "example":"8833057699"
                            },
                            "unitOfMeasure2":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "serviceQuantityIdentifier2":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Service Quantity Identifier"
                            },
                            "timeOfUse2":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            },
                            "finalUomDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Final Uom Description"
                            },
                            "finalSqiDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Final SQI Description"
                            },
                            "finalTouDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"Final TOU Description"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "items":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Sequence"
                            },
                            "itemType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Item Type is the type of item.",
                                "example":"Generic Current Transformer"
                            },
                            "item":{
                                "type":"object",
                                "properties":{
                                    "item":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Item ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "startDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Start Date"
                            },
                            "endDate":{
                                "type":"string",
                                "format":"date",
                                "description":"End Date"
                            },
                            "itemCount":{
                                "type":"number",
                                "maximum":9.9999999999E8,
                                "minimum":-9.9999999999E8,
                                "description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.",
                                "example":"1.00"
                            },
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "dailyServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Daily Service Quantity is the item's estimated amount of daily consumption.",
                                "example":"470.762600"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "serviceQuantities":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "timeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            },
                            "serviceQuantityIdentifier":{
                                "type":"string",
                                "maxLength":30,
                                "description":"SQI"
                            },
                            "initialServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
                                "example":"470.762600"
                            },
                            "billableServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Billable Service Quantity"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "calcLines":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "headerSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Header Sequence"
                            },
                            "startDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Start Date"
                            },
                            "endDate":{
                                "type":"string",
                                "format":"date",
                                "description":"End Date"
                            },
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code"
                            },
                            "calculatedAmount":{
                                "type":"number",
                                "description":"Calculated Amount"
                            },
                            "rateSchedule":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Rate Schedule"
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "billableCharge":{
                                "type":"object",
                                "properties":{
                                    "billableChargeId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Billable Charge ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "descriptionOnBill":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Description on Bill"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "calculationLines":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "headerSequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Header Sequence"
                                                },
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Sequence"
                                                },
                                                "characteristicType":{
                                                    "type":"object",
                                                    "properties":{
                                                        "characteristicType":{
                                                            "type":"string",
                                                            "maxLength":8,
                                                            "description":"Characteristic Type"
                                                        },
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        }
                                                    }
                                                },
                                                "currency":{
                                                    "type":"string",
                                                    "maxLength":3,
                                                    "description":"Currency Code"
                                                },
                                                "characteristicValue":{
                                                    "type":"string",
                                                    "maxLength":16,
                                                    "description":"Characteristic Value"
                                                },
                                                "distributionCode":{
                                                    "type":"object",
                                                    "properties":{
                                                        "distributionCode":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Distribution Code"
                                                        },
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        }
                                                    }
                                                },
                                                "unitOfMeasure":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Unit of Measure"
                                                },
                                                "timeOfUse":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Time of Use"
                                                },
                                                "rcSequence":{
                                                    "type":"number",
                                                    "maximum":9999,
                                                    "minimum":-9999,
                                                    "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                                                    "example":"10"
                                                },
                                                "shouldPrint":{
                                                    "type":"boolean",
                                                    "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                                    "example":"true"
                                                },
                                                "shouldAppearInSummary":{
                                                    "type":"boolean",
                                                    "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                                    "example":"true"
                                                },
                                                "calculatedAmount":{
                                                    "type":"number",
                                                    "description":"Calculated Amount"
                                                },
                                                "exemptAmount":{
                                                    "type":"number",
                                                    "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                                                    "example":"$0.00"
                                                },
                                                "baseAmount":{
                                                    "type":"number",
                                                    "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                                                    "example":"$102.71"
                                                },
                                                "serviceQuantityIdentifier":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"SQI"
                                                },
                                                "billableServiceQuantity":{
                                                    "type":"number",
                                                    "maximum":1.0E12,
                                                    "minimum":-1.0E12,
                                                    "description":"Billable Service Quantity"
                                                },
                                                "measuresPeakQuantity":{
                                                    "type":"boolean",
                                                    "description":"Measures Peak Qty"
                                                },
                                                "descriptionOnBill":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Description on Bill"
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                },
                                                "distributionDescription":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Distribution Code Description"
                                                },
                                                "isCharacteristicExist":{
                                                    "type":"boolean",
                                                    "description":"Characteristic exists",
                                                    "example":"false"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "financialDetails":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "financialTransactionId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).",
                                "example":"211166656266"
                            },
                            "financialTransactionType":{
                                "type":"string",
                                "enum":[
                                    "AD  ",
                                    "AX  ",
                                    "BS  ",
                                    "BX  ",
                                    "PS  ",
                                    "PX  "
                                ],
                                "description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation",
                                "example":"BS"
                            },
                            "financialTransactionTypeDescription":{
                                "type":"string",
                                "maxLength":150,
                                "description":"FT Type Description"
                            },
                            "currentAmount":{
                                "type":"number",
                                "description":"Current Amount"
                            },
                            "accountingDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Accounting Date"
                            },
                            "arrearsDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Arrears Date is the date the FT starts aging.",
                                "example":"03-04-2013"
                            },
                            "shouldShowOnBill":{
                                "type":"boolean",
                                "description":"Show on bill indicates if information about the FT appears on the customer's bill.",
                                "example":"true"
                            },
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Sequence"
                                        },
                                        "distributionCode":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Distribution Code"
                                        },
                                        "characteristicType":{
                                            "type":"string",
                                            "maxLength":8,
                                            "description":"Characteristic Type"
                                        },
                                        "characteristicValue":{
                                            "type":"string",
                                            "maxLength":16,
                                            "description":"Characteristic Value"
                                        },
                                        "amount":{
                                            "type":"number",
                                            "description":"Amount defines the journal line's amount.",
                                            "example":"$33.00"
                                        },
                                        "statistics":{
                                            "type":"string",
                                            "maxLength":8,
                                            "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                                            "example":"CF"
                                        },
                                        "statisticAmount":{
                                            "type":"number",
                                            "maximum":1.0E13,
                                            "minimum":-1.0E13,
                                            "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                                            "example":"0.000"
                                        },
                                        "isTotalAmount":{
                                            "type":"boolean",
                                            "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                                            "example":"true"
                                        },
                                        "distributionDescription":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Distribution Code Description"
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "subBillSegments":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "currentAmount":{
                                "type":"number",
                                "description":"Current Amount"
                            },
                            "billSegmentStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "40  ",
                                    "50  ",
                                    "60  ",
                                    "70  "
                                ],
                                "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
                            }
                        }
                    }
                }
            }
        },
        "messages":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "billMessageCode":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Bill Message"
                            },
                            "insert":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Insert Code defines if the bill message causes an insert in the envelope."
                            },
                            "messagePriority":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "40  ",
                                    "50  ",
                                    "60  ",
                                    "70  ",
                                    "80  ",
                                    "90  "
                                ],
                                "description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest",
                                "example":"20"
                            },
                            "messageOnBill":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Message On Bill is the message associated with the code.",
                                "example":"Electric service not billed"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "nextActions":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "action":{
                        "type":"string",
                        "enum":[
                            "C1CF",
                            "C1CO",
                            "C1CR",
                            "C1DE",
                            "C1FR",
                            "C1GN",
                            "C1RO"
                        ],
                        "description":"Bill Web Service Actions:\n* `C1CF` - Cancel Frozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-BillSegm"
    }
}

Nested Schema : account

Type: object

Show Source

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

  Account ID identifies the customer who is responsible for the bill.

  Example: 1112345900

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID identifies the customer who is responsible for the bill.",
            "example":"1112345900"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : bill

Type: object

Show Source

• _link: string
  _link
• billId: string
  Maximum Length: 12

  Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.

  Example: 211122345678

{
    "type":"object",
    "properties":{
        "billId":{
            "type":"string",
            "maxLength":12,
            "description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
            "example":"211122345678"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : billCycle

Type: object

Bill Cycle displays the bill cycle and window start date of the bill segment's bill.

Show Source

• _link: string
  _link
• billCycle: string
  Maximum Length: 4

  Bill Cycle displays the bill cycle and window start date of the bill segment's bill.

  Example: M-D2 (Monthly bill cycle - day 2)

{
    "type":"object",
    "description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.",
    "properties":{
        "billCycle":{
            "type":"string",
            "maxLength":4,
            "description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.",
            "example":"M-D2 (Monthly bill cycle - day 2)"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : calcLines

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "headerSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Header Sequence"
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Start Date"
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"End Date"
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code"
                    },
                    "calculatedAmount":{
                        "type":"number",
                        "description":"Calculated Amount"
                    },
                    "rateSchedule":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Rate Schedule"
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "billableCharge":{
                        "type":"object",
                        "properties":{
                            "billableChargeId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Billable Charge ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "descriptionOnBill":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Description on Bill"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "calculationLines":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "headerSequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Header Sequence"
                                        },
                                        "sequence":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Sequence"
                                        },
                                        "characteristicType":{
                                            "type":"object",
                                            "properties":{
                                                "characteristicType":{
                                                    "type":"string",
                                                    "maxLength":8,
                                                    "description":"Characteristic Type"
                                                },
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                }
                                            }
                                        },
                                        "currency":{
                                            "type":"string",
                                            "maxLength":3,
                                            "description":"Currency Code"
                                        },
                                        "characteristicValue":{
                                            "type":"string",
                                            "maxLength":16,
                                            "description":"Characteristic Value"
                                        },
                                        "distributionCode":{
                                            "type":"object",
                                            "properties":{
                                                "distributionCode":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Distribution Code"
                                                },
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                }
                                            }
                                        },
                                        "unitOfMeasure":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Unit of Measure"
                                        },
                                        "timeOfUse":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Time of Use"
                                        },
                                        "rcSequence":{
                                            "type":"number",
                                            "maximum":9999,
                                            "minimum":-9999,
                                            "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                                            "example":"10"
                                        },
                                        "shouldPrint":{
                                            "type":"boolean",
                                            "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                            "example":"true"
                                        },
                                        "shouldAppearInSummary":{
                                            "type":"boolean",
                                            "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                            "example":"true"
                                        },
                                        "calculatedAmount":{
                                            "type":"number",
                                            "description":"Calculated Amount"
                                        },
                                        "exemptAmount":{
                                            "type":"number",
                                            "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                                            "example":"$0.00"
                                        },
                                        "baseAmount":{
                                            "type":"number",
                                            "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                                            "example":"$102.71"
                                        },
                                        "serviceQuantityIdentifier":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"SQI"
                                        },
                                        "billableServiceQuantity":{
                                            "type":"number",
                                            "maximum":1.0E12,
                                            "minimum":-1.0E12,
                                            "description":"Billable Service Quantity"
                                        },
                                        "measuresPeakQuantity":{
                                            "type":"boolean",
                                            "description":"Measures Peak Qty"
                                        },
                                        "descriptionOnBill":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Description on Bill"
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        },
                                        "distributionDescription":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Distribution Code Description"
                                        },
                                        "isCharacteristicExist":{
                                            "type":"boolean",
                                            "description":"Characteristic exists",
                                            "example":"false"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : cancelReason

Type: object

Cancel Reason defines why the bill segment(s) are being canceled.

Show Source

• _link: string
  _link
• cancelReason: string
  Maximum Length: 4

  Cancel Reason defines why the bill segment(s) are being canceled.

  Example: Wrong read

{
    "type":"object",
    "description":"Cancel Reason defines why the bill segment(s) are being canceled.",
    "properties":{
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason defines why the bill segment(s) are being canceled.",
            "example":"Wrong read"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : currency

Type: object

Show Source

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

  Currency Code

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

Nested Schema : exception

Type: object

Show Source

• expandedMessage: string
  Maximum Length: 254

  Expanded Message exception
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message category within Oracle Utilities Application Framework.

  Example: 0
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message number within Oracle Utilities Application Framework.

  Example: 0

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message category within Oracle Utilities Application Framework.",
            "example":"0"
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message number within Oracle Utilities Application Framework.",
            "example":"0"
        },
        "expandedMessage":{
            "type":"string",
            "maxLength":254,
            "description":"Expanded Message exception"
        }
    }
}

Nested Schema : financialDetails

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "financialTransactionId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).",
                        "example":"211166656266"
                    },
                    "financialTransactionType":{
                        "type":"string",
                        "enum":[
                            "AD  ",
                            "AX  ",
                            "BS  ",
                            "BX  ",
                            "PS  ",
                            "PX  "
                        ],
                        "description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation",
                        "example":"BS"
                    },
                    "financialTransactionTypeDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"FT Type Description"
                    },
                    "currentAmount":{
                        "type":"number",
                        "description":"Current Amount"
                    },
                    "accountingDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Accounting Date"
                    },
                    "arrearsDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Arrears Date is the date the FT starts aging.",
                        "example":"03-04-2013"
                    },
                    "shouldShowOnBill":{
                        "type":"boolean",
                        "description":"Show on bill indicates if information about the FT appears on the customer's bill.",
                        "example":"true"
                    },
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence"
                                },
                                "distributionCode":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Distribution Code"
                                },
                                "characteristicType":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"Characteristic Type"
                                },
                                "characteristicValue":{
                                    "type":"string",
                                    "maxLength":16,
                                    "description":"Characteristic Value"
                                },
                                "amount":{
                                    "type":"number",
                                    "description":"Amount defines the journal line's amount.",
                                    "example":"$33.00"
                                },
                                "statistics":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                                    "example":"CF"
                                },
                                "statisticAmount":{
                                    "type":"number",
                                    "maximum":1.0E13,
                                    "minimum":-1.0E13,
                                    "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                                    "example":"0.000"
                                },
                                "isTotalAmount":{
                                    "type":"boolean",
                                    "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                                    "example":"true"
                                },
                                "distributionDescription":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Distribution Code Description"
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Sequence"
                    },
                    "itemType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Item Type is the type of item.",
                        "example":"Generic Current Transformer"
                    },
                    "item":{
                        "type":"object",
                        "properties":{
                            "item":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Item ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Start Date"
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"End Date"
                    },
                    "itemCount":{
                        "type":"number",
                        "maximum":9.9999999999E8,
                        "minimum":-9.9999999999E8,
                        "description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.",
                        "example":"1.00"
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "dailyServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Daily Service Quantity is the item's estimated amount of daily consumption.",
                        "example":"470.762600"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : messages

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "billMessageCode":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Bill Message"
                    },
                    "insert":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Insert Code defines if the bill message causes an insert in the envelope."
                    },
                    "messagePriority":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  ",
                            "50  ",
                            "60  ",
                            "70  ",
                            "80  ",
                            "90  "
                        ],
                        "description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest",
                        "example":"20"
                    },
                    "messageOnBill":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Message On Bill is the message associated with the code.",
                        "example":"Electric service not billed"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : nextActions

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "action":{
                "type":"string",
                "enum":[
                    "C1CF",
                    "C1CO",
                    "C1CR",
                    "C1DE",
                    "C1FR",
                    "C1GN",
                    "C1RO"
                ],
                "description":"Bill Web Service Actions:\n* `C1CF` - Cancel Frozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen"
            }
        }
    }
}

Nested Schema : premise

Type: object

Show Source

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

  Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise.

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : quote

Type: object

Show Source

• _link: string
  _link
• quoteId: string
  Maximum Length: 12

  Quote ID is the system-assigned unique identifier of the quote.

{
    "type":"object",
    "properties":{
        "quoteId":{
            "type":"string",
            "maxLength":12,
            "description":"Quote ID is the system-assigned unique identifier of the quote."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : readDetails

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "finalUnitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.",
                        "example":"CF"
                    },
                    "finalTimeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Final Time of Use is the final time-of-use code of the calculation / audit read.",
                        "example":"ON"
                    },
                    "finalServiceQuantityId":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Final SQI is the final service quantity identifier of the calculation / audit read.",
                        "example":"DAMT"
                    },
                    "registerQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.",
                        "example":"200.000000"
                    },
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID"
                    },
                    "meterConfigurationId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Meter Configuration ID"
                    },
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Sequence"
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "serviceQuantityIdentifier":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI"
                    },
                    "startRegisterReading":{
                        "type":"number",
                        "maximum":9.99999999999999E8,
                        "minimum":-9.99999999999999E8,
                        "description":"Start Register Reading is the start register reading.",
                        "example":"7201.000000"
                    },
                    "endRegisterReading":{
                        "type":"number",
                        "maximum":9.99999999999999E8,
                        "minimum":-9.99999999999999E8,
                        "description":"End Register Reading is the end register reading.",
                        "example":"11578.000000"
                    },
                    "measuredQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive",
                        "example":"4377.000000"
                    },
                    "registerConstant":{
                        "type":"number",
                        "maximum":999999.999999,
                        "minimum":-999999.999999,
                        "description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.",
                        "example":"1.000000"
                    },
                    "howToUse":{
                        "type":"string",
                        "enum":[
                            "+   ",
                            "-   ",
                            "C   ",
                            "P   "
                        ],
                        "description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak",
                        "example":"+"
                    },
                    "howToUseRead":{
                        "type":"string",
                        "enum":[
                            "+   ",
                            "-   ",
                            "C   ",
                            "S   ",
                            "X   "
                        ],
                        "description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit",
                        "example":"+"
                    },
                    "usePercent":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Use Percent is the percentage of the total consumption that was billed.",
                        "example":"100"
                    },
                    "measuresPeakQuantity":{
                        "type":"boolean",
                        "description":"Measures Peak Qty"
                    },
                    "startReadDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Start Read Date/Time is the date and time of the start meter read.",
                        "example":"1998-06-30T00:00:00-04:00"
                    },
                    "endReadDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"End Read Date/Time is the date and time of the end meter read.",
                        "example":"998-09-30T00:00:00-04:00"
                    },
                    "startRegisterReadId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Start Register Read ID is the unique identifier of the start register read.",
                        "example":"444074862768"
                    },
                    "endRegisterReadingId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"End Register Read ID is the unique identifier of the end register read.",
                        "example":"444074849655"
                    },
                    "startRegisterReadTypeDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Start Register Read Type Description"
                    },
                    "endRegisterReadTypeDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"End Register Read Type Description"
                    },
                    "multiplier":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
                        "example":"1.000000"
                    },
                    "consumptionType":{
                        "type":"string",
                        "enum":[
                            "C   ",
                            "S   "
                        ],
                        "description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive",
                        "example":"S"
                    },
                    "notAvailableConsumptionDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Not Available Consumption Description"
                    },
                    "startMeterRead":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Start meter read ID",
                        "example":"444074813104"
                    },
                    "endMeterRead":{
                        "type":"string",
                        "maxLength":12,
                        "description":"End meter read ID",
                        "example":"44074866808"
                    },
                    "meterReadId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Meter Read ID",
                        "example":"8833057699"
                    },
                    "unitOfMeasure2":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "serviceQuantityIdentifier2":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service Quantity Identifier"
                    },
                    "timeOfUse2":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "finalUomDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Final Uom Description"
                    },
                    "finalSqiDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Final SQI Description"
                    },
                    "finalTouDescription":{
                        "type":"string",
                        "maxLength":150,
                        "description":"Final TOU Description"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : serviceAgreement

Type: object

SA ID contains information about the bill segment's service agreement.

Show Source

• _link: string
  _link
• serviceAgreement: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "description":"SA ID contains information about the bill segment's service agreement.",
    "properties":{
        "serviceAgreement":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : serviceQuantities

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "serviceQuantityIdentifier":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI"
                    },
                    "initialServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
                        "example":"470.762600"
                    },
                    "billableServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Billable Service Quantity"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : subBillSegments

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "currentAmount":{
                        "type":"number",
                        "description":"Current Amount"
                    },
                    "billSegmentStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  ",
                            "50  ",
                            "60  ",
                            "70  "
                        ],
                        "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "headerSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Header Sequence"
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"Start Date"
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"End Date"
            },
            "currency":{
                "type":"string",
                "maxLength":3,
                "description":"Currency Code"
            },
            "calculatedAmount":{
                "type":"number",
                "description":"Calculated Amount"
            },
            "rateSchedule":{
                "type":"string",
                "maxLength":8,
                "description":"Rate Schedule"
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "billableCharge":{
                "type":"object",
                "properties":{
                    "billableChargeId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Billable Charge ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "descriptionOnBill":{
                "type":"string",
                "maxLength":254,
                "description":"Description on Bill"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "calculationLines":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "headerSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Header Sequence"
                                },
                                "sequence":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Sequence"
                                },
                                "characteristicType":{
                                    "type":"object",
                                    "properties":{
                                        "characteristicType":{
                                            "type":"string",
                                            "maxLength":8,
                                            "description":"Characteristic Type"
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                },
                                "currency":{
                                    "type":"string",
                                    "maxLength":3,
                                    "description":"Currency Code"
                                },
                                "characteristicValue":{
                                    "type":"string",
                                    "maxLength":16,
                                    "description":"Characteristic Value"
                                },
                                "distributionCode":{
                                    "type":"object",
                                    "properties":{
                                        "distributionCode":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Distribution Code"
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                },
                                "unitOfMeasure":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Unit of Measure"
                                },
                                "timeOfUse":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Time of Use"
                                },
                                "rcSequence":{
                                    "type":"number",
                                    "maximum":9999,
                                    "minimum":-9999,
                                    "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                                    "example":"10"
                                },
                                "shouldPrint":{
                                    "type":"boolean",
                                    "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                    "example":"true"
                                },
                                "shouldAppearInSummary":{
                                    "type":"boolean",
                                    "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                    "example":"true"
                                },
                                "calculatedAmount":{
                                    "type":"number",
                                    "description":"Calculated Amount"
                                },
                                "exemptAmount":{
                                    "type":"number",
                                    "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                                    "example":"$0.00"
                                },
                                "baseAmount":{
                                    "type":"number",
                                    "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                                    "example":"$102.71"
                                },
                                "serviceQuantityIdentifier":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"SQI"
                                },
                                "billableServiceQuantity":{
                                    "type":"number",
                                    "maximum":1.0E12,
                                    "minimum":-1.0E12,
                                    "description":"Billable Service Quantity"
                                },
                                "measuresPeakQuantity":{
                                    "type":"boolean",
                                    "description":"Measures Peak Qty"
                                },
                                "descriptionOnBill":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Description on Bill"
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                },
                                "distributionDescription":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Distribution Code Description"
                                },
                                "isCharacteristicExist":{
                                    "type":"boolean",
                                    "description":"Characteristic exists",
                                    "example":"false"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billableCharge: object billableCharge
• calculatedAmount: number
  Calculated Amount
• calculationLines: object calculationLines
• currency: string
  Maximum Length: 3

  Currency Code
• descriptionOnBill: string
  Maximum Length: 254

  Description on Bill
• effectiveDate: string (date)
  Effective Date
• endDate: string (date)
  End Date
• headerSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Header Sequence
• rateSchedule: string
  Maximum Length: 8

  Rate Schedule
• startDate: string (date)
  Start Date
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "headerSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Header Sequence"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date"
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "calculatedAmount":{
            "type":"number",
            "description":"Calculated Amount"
        },
        "rateSchedule":{
            "type":"string",
            "maxLength":8,
            "description":"Rate Schedule"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "billableCharge":{
            "type":"object",
            "properties":{
                "billableChargeId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Billable Charge ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "descriptionOnBill":{
            "type":"string",
            "maxLength":254,
            "description":"Description on Bill"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "calculationLines":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "headerSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Header Sequence"
                            },
                            "sequence":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Sequence"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code"
                            },
                            "characteristicValue":{
                                "type":"string",
                                "maxLength":16,
                                "description":"Characteristic Value"
                            },
                            "distributionCode":{
                                "type":"object",
                                "properties":{
                                    "distributionCode":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Distribution Code"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "timeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            },
                            "rcSequence":{
                                "type":"number",
                                "maximum":9999,
                                "minimum":-9999,
                                "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                                "example":"10"
                            },
                            "shouldPrint":{
                                "type":"boolean",
                                "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                "example":"true"
                            },
                            "shouldAppearInSummary":{
                                "type":"boolean",
                                "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                "example":"true"
                            },
                            "calculatedAmount":{
                                "type":"number",
                                "description":"Calculated Amount"
                            },
                            "exemptAmount":{
                                "type":"number",
                                "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                                "example":"$0.00"
                            },
                            "baseAmount":{
                                "type":"number",
                                "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                                "example":"$102.71"
                            },
                            "serviceQuantityIdentifier":{
                                "type":"string",
                                "maxLength":30,
                                "description":"SQI"
                            },
                            "billableServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Billable Service Quantity"
                            },
                            "measuresPeakQuantity":{
                                "type":"boolean",
                                "description":"Measures Peak Qty"
                            },
                            "descriptionOnBill":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Description on Bill"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "distributionDescription":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Distribution Code Description"
                            },
                            "isCharacteristicExist":{
                                "type":"boolean",
                                "description":"Characteristic exists",
                                "example":"false"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : billableCharge

Type: object

Show Source

• _link: string
  _link
• billableChargeId: string
  Maximum Length: 12

  Billable Charge ID

{
    "type":"object",
    "properties":{
        "billableChargeId":{
            "type":"string",
            "maxLength":12,
            "description":"Billable Charge ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : calculationLines

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "headerSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Header Sequence"
                    },
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Sequence"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code"
                    },
                    "characteristicValue":{
                        "type":"string",
                        "maxLength":16,
                        "description":"Characteristic Value"
                    },
                    "distributionCode":{
                        "type":"object",
                        "properties":{
                            "distributionCode":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Distribution Code"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "rcSequence":{
                        "type":"number",
                        "maximum":9999,
                        "minimum":-9999,
                        "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                        "example":"10"
                    },
                    "shouldPrint":{
                        "type":"boolean",
                        "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                        "example":"true"
                    },
                    "shouldAppearInSummary":{
                        "type":"boolean",
                        "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                        "example":"true"
                    },
                    "calculatedAmount":{
                        "type":"number",
                        "description":"Calculated Amount"
                    },
                    "exemptAmount":{
                        "type":"number",
                        "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                        "example":"$0.00"
                    },
                    "baseAmount":{
                        "type":"number",
                        "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                        "example":"$102.71"
                    },
                    "serviceQuantityIdentifier":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI"
                    },
                    "billableServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Billable Service Quantity"
                    },
                    "measuresPeakQuantity":{
                        "type":"boolean",
                        "description":"Measures Peak Qty"
                    },
                    "descriptionOnBill":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Description on Bill"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "distributionDescription":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Distribution Code Description"
                    },
                    "isCharacteristicExist":{
                        "type":"boolean",
                        "description":"Characteristic exists",
                        "example":"false"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "headerSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Header Sequence"
            },
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Sequence"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "currency":{
                "type":"string",
                "maxLength":3,
                "description":"Currency Code"
            },
            "characteristicValue":{
                "type":"string",
                "maxLength":16,
                "description":"Characteristic Value"
            },
            "distributionCode":{
                "type":"object",
                "properties":{
                    "distributionCode":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Distribution Code"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use"
            },
            "rcSequence":{
                "type":"number",
                "maximum":9999,
                "minimum":-9999,
                "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
                "example":"10"
            },
            "shouldPrint":{
                "type":"boolean",
                "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                "example":"true"
            },
            "shouldAppearInSummary":{
                "type":"boolean",
                "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                "example":"true"
            },
            "calculatedAmount":{
                "type":"number",
                "description":"Calculated Amount"
            },
            "exemptAmount":{
                "type":"number",
                "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
                "example":"$0.00"
            },
            "baseAmount":{
                "type":"number",
                "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
                "example":"$102.71"
            },
            "serviceQuantityIdentifier":{
                "type":"string",
                "maxLength":30,
                "description":"SQI"
            },
            "billableServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Billable Service Quantity"
            },
            "measuresPeakQuantity":{
                "type":"boolean",
                "description":"Measures Peak Qty"
            },
            "descriptionOnBill":{
                "type":"string",
                "maxLength":254,
                "description":"Description on Bill"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "distributionDescription":{
                "type":"string",
                "maxLength":30,
                "description":"Distribution Code Description"
            },
            "isCharacteristicExist":{
                "type":"boolean",
                "description":"Characteristic exists",
                "example":"false"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• baseAmount: number
  Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.

  Example: $102.71
• billableServiceQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Billable Service Quantity
• calculatedAmount: number
  Calculated Amount
• characteristicType: object characteristicType
• characteristicValue: string
  Maximum Length: 16

  Characteristic Value
• currency: string
  Maximum Length: 3

  Currency Code
• descriptionOnBill: string
  Maximum Length: 254

  Description on Bill
• distributionCode: object distributionCode
• distributionDescription: string
  Maximum Length: 30

  Distribution Code Description
• exemptAmount: number
  Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.

  Example: $0.00
• headerSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Header Sequence
• isCharacteristicExist: boolean
  Characteristic exists

  Example: false
• measuresPeakQuantity: boolean
  Measures Peak Qty
• rcSequence: number
  Minimum Value: -9999

  Maximum Value: 9999

  Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.

  Example: 10
• sequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Sequence
• serviceQuantityIdentifier: string
  Maximum Length: 30

  SQI
• shouldAppearInSummary: boolean
  The Appears in Summary switch defines if this line's amount also appears on a summary line.

  Example: true
• shouldPrint: boolean
  The Print switch controls whether information about this line will print on the customer's bill.

  Example: true
• timeOfUse: string
  Maximum Length: 30

  Time of Use
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "headerSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Header Sequence"
        },
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "characteristicValue":{
            "type":"string",
            "maxLength":16,
            "description":"Characteristic Value"
        },
        "distributionCode":{
            "type":"object",
            "properties":{
                "distributionCode":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Distribution Code"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "rcSequence":{
            "type":"number",
            "maximum":9999,
            "minimum":-9999,
            "description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.",
            "example":"10"
        },
        "shouldPrint":{
            "type":"boolean",
            "description":"The Print switch controls whether information about this line will print on the customer's bill.",
            "example":"true"
        },
        "shouldAppearInSummary":{
            "type":"boolean",
            "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
            "example":"true"
        },
        "calculatedAmount":{
            "type":"number",
            "description":"Calculated Amount"
        },
        "exemptAmount":{
            "type":"number",
            "description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.",
            "example":"$0.00"
        },
        "baseAmount":{
            "type":"number",
            "description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.",
            "example":"$102.71"
        },
        "serviceQuantityIdentifier":{
            "type":"string",
            "maxLength":30,
            "description":"SQI"
        },
        "billableServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Billable Service Quantity"
        },
        "measuresPeakQuantity":{
            "type":"boolean",
            "description":"Measures Peak Qty"
        },
        "descriptionOnBill":{
            "type":"string",
            "maxLength":254,
            "description":"Description on Bill"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "distributionDescription":{
            "type":"string",
            "maxLength":30,
            "description":"Distribution Code Description"
        },
        "isCharacteristicExist":{
            "type":"boolean",
            "description":"Characteristic exists",
            "example":"false"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

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

  Characteristic Type

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

Nested Schema : distributionCode

Type: object

Show Source

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

  Distribution Code

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

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "financialTransactionId":{
                "type":"string",
                "maxLength":12,
                "description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).",
                "example":"211166656266"
            },
            "financialTransactionType":{
                "type":"string",
                "enum":[
                    "AD  ",
                    "AX  ",
                    "BS  ",
                    "BX  ",
                    "PS  ",
                    "PX  "
                ],
                "description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation",
                "example":"BS"
            },
            "financialTransactionTypeDescription":{
                "type":"string",
                "maxLength":150,
                "description":"FT Type Description"
            },
            "currentAmount":{
                "type":"number",
                "description":"Current Amount"
            },
            "accountingDate":{
                "type":"string",
                "format":"date",
                "description":"Accounting Date"
            },
            "arrearsDate":{
                "type":"string",
                "format":"date",
                "description":"Arrears Date is the date the FT starts aging.",
                "example":"03-04-2013"
            },
            "shouldShowOnBill":{
                "type":"boolean",
                "description":"Show on bill indicates if information about the FT appears on the customer's bill.",
                "example":"true"
            },
            "_data":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "sequence":{
                            "type":"number",
                            "maximum":999,
                            "minimum":-999,
                            "description":"Sequence"
                        },
                        "distributionCode":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Distribution Code"
                        },
                        "characteristicType":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Characteristic Type"
                        },
                        "characteristicValue":{
                            "type":"string",
                            "maxLength":16,
                            "description":"Characteristic Value"
                        },
                        "amount":{
                            "type":"number",
                            "description":"Amount defines the journal line's amount.",
                            "example":"$33.00"
                        },
                        "statistics":{
                            "type":"string",
                            "maxLength":8,
                            "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                            "example":"CF"
                        },
                        "statisticAmount":{
                            "type":"number",
                            "maximum":1.0E13,
                            "minimum":-1.0E13,
                            "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                            "example":"0.000"
                        },
                        "isTotalAmount":{
                            "type":"boolean",
                            "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                            "example":"true"
                        },
                        "distributionDescription":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Distribution Code Description"
                        },
                        "version":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Version"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• _data: array _data
• accountingDate: string (date)
  Accounting Date
• arrearsDate: string (date)
  Arrears Date is the date the FT starts aging.

  Example: 03-04-2013
• currentAmount: number
  Current Amount
• financialTransactionId: string
  Maximum Length: 12

  FT ID is the system-assigned unique identifier of the financial transaction (FT).

  Example: 211166656266
• financialTransactionType: string
  Allowed Values: [ "AD ", "AX ", "BS ", "BX ", "PS ", "PX " ]

  Financial Transaction Type: AD - Adjustment, AX - Adjustment Cancellation, BS - Bill Segment, BX - Bill Segment Cancellation, PS - Pay Segment, PX - Pay Segment Cancellation * `AD ` - Adjustment, * `AX ` - Adjustment Cancellation, * `BS ` - Bill Segment, * `BX ` - Bill Segment Cancellation, * `PS ` - Pay Segment, * `PX ` - Pay Segment Cancellation

  Example: BS
• financialTransactionTypeDescription: string
  Maximum Length: 150

  FT Type Description
• shouldShowOnBill: boolean
  Show on bill indicates if information about the FT appears on the customer's bill.

  Example: true

{
    "type":"object",
    "properties":{
        "financialTransactionId":{
            "type":"string",
            "maxLength":12,
            "description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).",
            "example":"211166656266"
        },
        "financialTransactionType":{
            "type":"string",
            "enum":[
                "AD  ",
                "AX  ",
                "BS  ",
                "BX  ",
                "PS  ",
                "PX  "
            ],
            "description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation",
            "example":"BS"
        },
        "financialTransactionTypeDescription":{
            "type":"string",
            "maxLength":150,
            "description":"FT Type Description"
        },
        "currentAmount":{
            "type":"number",
            "description":"Current Amount"
        },
        "accountingDate":{
            "type":"string",
            "format":"date",
            "description":"Accounting Date"
        },
        "arrearsDate":{
            "type":"string",
            "format":"date",
            "description":"Arrears Date is the date the FT starts aging.",
            "example":"03-04-2013"
        },
        "shouldShowOnBill":{
            "type":"boolean",
            "description":"Show on bill indicates if information about the FT appears on the customer's bill.",
            "example":"true"
        },
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence"
                    },
                    "distributionCode":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Distribution Code"
                    },
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    },
                    "characteristicValue":{
                        "type":"string",
                        "maxLength":16,
                        "description":"Characteristic Value"
                    },
                    "amount":{
                        "type":"number",
                        "description":"Amount defines the journal line's amount.",
                        "example":"$33.00"
                    },
                    "statistics":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                        "example":"CF"
                    },
                    "statisticAmount":{
                        "type":"number",
                        "maximum":1.0E13,
                        "minimum":-1.0E13,
                        "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                        "example":"0.000"
                    },
                    "isTotalAmount":{
                        "type":"boolean",
                        "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                        "example":"true"
                    },
                    "distributionDescription":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Distribution Code Description"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence"
            },
            "distributionCode":{
                "type":"string",
                "maxLength":10,
                "description":"Distribution Code"
            },
            "characteristicType":{
                "type":"string",
                "maxLength":8,
                "description":"Characteristic Type"
            },
            "characteristicValue":{
                "type":"string",
                "maxLength":16,
                "description":"Characteristic Value"
            },
            "amount":{
                "type":"number",
                "description":"Amount defines the journal line's amount.",
                "example":"$33.00"
            },
            "statistics":{
                "type":"string",
                "maxLength":8,
                "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
                "example":"CF"
            },
            "statisticAmount":{
                "type":"number",
                "maximum":1.0E13,
                "minimum":-1.0E13,
                "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
                "example":"0.000"
            },
            "isTotalAmount":{
                "type":"boolean",
                "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
                "example":"true"
            },
            "distributionDescription":{
                "type":"string",
                "maxLength":30,
                "description":"Distribution Code Description"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount: number
  Amount defines the journal line's amount.

  Example: $33.00
• characteristicType: string
  Maximum Length: 8

  Characteristic Type
• characteristicValue: string
  Maximum Length: 16

  Characteristic Value
• distributionCode: string
  Maximum Length: 10

  Distribution Code
• distributionDescription: string
  Maximum Length: 30

  Distribution Code Description
• isTotalAmount: boolean
  Total Amount defines if the journal line contains the total of the other journal lines.

  Example: true
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence
• statisticAmount: number
  Minimum Value: -1.0E13

  Maximum Value: 1.0E13

  Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.

  Example: 0.000
• statistics: string
  Maximum Length: 8

  Statistics Code is only specified when a statistical quantity is associated with the distribution line.

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

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence"
        },
        "distributionCode":{
            "type":"string",
            "maxLength":10,
            "description":"Distribution Code"
        },
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        },
        "characteristicValue":{
            "type":"string",
            "maxLength":16,
            "description":"Characteristic Value"
        },
        "amount":{
            "type":"number",
            "description":"Amount defines the journal line's amount.",
            "example":"$33.00"
        },
        "statistics":{
            "type":"string",
            "maxLength":8,
            "description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.",
            "example":"CF"
        },
        "statisticAmount":{
            "type":"number",
            "maximum":1.0E13,
            "minimum":-1.0E13,
            "description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.",
            "example":"0.000"
        },
        "isTotalAmount":{
            "type":"boolean",
            "description":"Total Amount defines if the journal line contains the total of the other journal lines.",
            "example":"true"
        },
        "distributionDescription":{
            "type":"string",
            "maxLength":30,
            "description":"Distribution Code Description"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Sequence"
            },
            "itemType":{
                "type":"string",
                "maxLength":30,
                "description":"Item Type is the type of item.",
                "example":"Generic Current Transformer"
            },
            "item":{
                "type":"object",
                "properties":{
                    "item":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Item ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"Start Date"
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"End Date"
            },
            "itemCount":{
                "type":"number",
                "maximum":9.9999999999E8,
                "minimum":-9.9999999999E8,
                "description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.",
                "example":"1.00"
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "dailyServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Daily Service Quantity is the item's estimated amount of daily consumption.",
                "example":"470.762600"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dailyServiceQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Daily Service Quantity is the item's estimated amount of daily consumption.

  Example: 470.762600
• endDate: string (date)
  End Date
• item: object item
• itemCount: number
  Minimum Value: -9.9999999999E8

  Maximum Value: 9.9999999999E8

  Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.

  Example: 1.00
• itemType: string
  Maximum Length: 30

  Item Type is the type of item.

  Example: Generic Current Transformer
• sequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Sequence
• startDate: string (date)
  Start Date
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence"
        },
        "itemType":{
            "type":"string",
            "maxLength":30,
            "description":"Item Type is the type of item.",
            "example":"Generic Current Transformer"
        },
        "item":{
            "type":"object",
            "properties":{
                "item":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Item ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date"
        },
        "itemCount":{
            "type":"number",
            "maximum":9.9999999999E8,
            "minimum":-9.9999999999E8,
            "description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.",
            "example":"1.00"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "dailyServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Daily Service Quantity is the item's estimated amount of daily consumption.",
            "example":"470.762600"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : item

Type: object

Show Source

• _link: string
  _link
• item: string
  Maximum Length: 10

  Item ID

{
    "type":"object",
    "properties":{
        "item":{
            "type":"string",
            "maxLength":10,
            "description":"Item ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "billMessageCode":{
                "type":"string",
                "maxLength":4,
                "description":"Bill Message"
            },
            "insert":{
                "type":"string",
                "maxLength":8,
                "description":"Insert Code defines if the bill message causes an insert in the envelope."
            },
            "messagePriority":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "40  ",
                    "50  ",
                    "60  ",
                    "70  ",
                    "80  ",
                    "90  "
                ],
                "description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest",
                "example":"20"
            },
            "messageOnBill":{
                "type":"string",
                "maxLength":254,
                "description":"Message On Bill is the message associated with the code.",
                "example":"Electric service not billed"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billMessageCode: string
  Maximum Length: 4

  Bill Message
• insert: string
  Maximum Length: 8

  Insert Code defines if the bill message causes an insert in the envelope.
• messageOnBill: string
  Maximum Length: 254

  Message On Bill is the message associated with the code.

  Example: Electric service not billed
• messagePriority: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "90 " ]

  Priority is the bill messages priority (on the printed bill). * `10 ` - Priority 10 -- Lowest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `90 ` - Priority 90 -- Highest

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

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "billMessageCode":{
            "type":"string",
            "maxLength":4,
            "description":"Bill Message"
        },
        "insert":{
            "type":"string",
            "maxLength":8,
            "description":"Insert Code defines if the bill message causes an insert in the envelope."
        },
        "messagePriority":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  ",
                "80  ",
                "90  "
            ],
            "description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest",
            "example":"20"
        },
        "messageOnBill":{
            "type":"string",
            "maxLength":254,
            "description":"Message On Bill is the message associated with the code.",
            "example":"Electric service not billed"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• action: string
  Allowed Values: [ "C1CF", "C1CO", "C1CR", "C1DE", "C1FR", "C1GN", "C1RO" ]

  Bill Web Service Actions: * `C1CF` - Cancel Frozen, * `C1CO` - Complete, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1RO` - ReOpen

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "C1CF",
                "C1CO",
                "C1CR",
                "C1DE",
                "C1FR",
                "C1GN",
                "C1RO"
            ],
            "description":"Bill Web Service Actions:\n* `C1CF` - Cancel Frozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "finalUnitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.",
                "example":"CF"
            },
            "finalTimeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Final Time of Use is the final time-of-use code of the calculation / audit read.",
                "example":"ON"
            },
            "finalServiceQuantityId":{
                "type":"string",
                "maxLength":30,
                "description":"Final SQI is the final service quantity identifier of the calculation / audit read.",
                "example":"DAMT"
            },
            "registerQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.",
                "example":"200.000000"
            },
            "servicePointId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID"
            },
            "meterConfigurationId":{
                "type":"string",
                "maxLength":10,
                "description":"Meter Configuration ID"
            },
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Sequence"
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use"
            },
            "serviceQuantityIdentifier":{
                "type":"string",
                "maxLength":30,
                "description":"SQI"
            },
            "startRegisterReading":{
                "type":"number",
                "maximum":9.99999999999999E8,
                "minimum":-9.99999999999999E8,
                "description":"Start Register Reading is the start register reading.",
                "example":"7201.000000"
            },
            "endRegisterReading":{
                "type":"number",
                "maximum":9.99999999999999E8,
                "minimum":-9.99999999999999E8,
                "description":"End Register Reading is the end register reading.",
                "example":"11578.000000"
            },
            "measuredQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive",
                "example":"4377.000000"
            },
            "registerConstant":{
                "type":"number",
                "maximum":999999.999999,
                "minimum":-999999.999999,
                "description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.",
                "example":"1.000000"
            },
            "howToUse":{
                "type":"string",
                "enum":[
                    "+   ",
                    "-   ",
                    "C   ",
                    "P   "
                ],
                "description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak",
                "example":"+"
            },
            "howToUseRead":{
                "type":"string",
                "enum":[
                    "+   ",
                    "-   ",
                    "C   ",
                    "S   ",
                    "X   "
                ],
                "description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit",
                "example":"+"
            },
            "usePercent":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Use Percent is the percentage of the total consumption that was billed.",
                "example":"100"
            },
            "measuresPeakQuantity":{
                "type":"boolean",
                "description":"Measures Peak Qty"
            },
            "startReadDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Start Read Date/Time is the date and time of the start meter read.",
                "example":"1998-06-30T00:00:00-04:00"
            },
            "endReadDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"End Read Date/Time is the date and time of the end meter read.",
                "example":"998-09-30T00:00:00-04:00"
            },
            "startRegisterReadId":{
                "type":"string",
                "maxLength":12,
                "description":"Start Register Read ID is the unique identifier of the start register read.",
                "example":"444074862768"
            },
            "endRegisterReadingId":{
                "type":"string",
                "maxLength":12,
                "description":"End Register Read ID is the unique identifier of the end register read.",
                "example":"444074849655"
            },
            "startRegisterReadTypeDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Start Register Read Type Description"
            },
            "endRegisterReadTypeDescription":{
                "type":"string",
                "maxLength":150,
                "description":"End Register Read Type Description"
            },
            "multiplier":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
                "example":"1.000000"
            },
            "consumptionType":{
                "type":"string",
                "enum":[
                    "C   ",
                    "S   "
                ],
                "description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive",
                "example":"S"
            },
            "notAvailableConsumptionDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Not Available Consumption Description"
            },
            "startMeterRead":{
                "type":"string",
                "maxLength":12,
                "description":"Start meter read ID",
                "example":"444074813104"
            },
            "endMeterRead":{
                "type":"string",
                "maxLength":12,
                "description":"End meter read ID",
                "example":"44074866808"
            },
            "meterReadId":{
                "type":"string",
                "maxLength":12,
                "description":"Meter Read ID",
                "example":"8833057699"
            },
            "unitOfMeasure2":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "serviceQuantityIdentifier2":{
                "type":"string",
                "maxLength":30,
                "description":"Service Quantity Identifier"
            },
            "timeOfUse2":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use"
            },
            "finalUomDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Final Uom Description"
            },
            "finalSqiDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Final SQI Description"
            },
            "finalTouDescription":{
                "type":"string",
                "maxLength":150,
                "description":"Final TOU Description"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• consumptionType: string
  Allowed Values: [ "C ", "S " ]

  Consumptive/Subtractive flag shows if the register is consumptive or subtractive. * `C ` - Consumptive, * `S ` - Subtractive

  Example: S
• endMeterRead: string
  Maximum Length: 12

  End meter read ID

  Example: 44074866808
• endReadDateTime: string (date-time)
  End Read Date/Time is the date and time of the end meter read.

  Example: 998-09-30T00:00:00-04:00
• endRegisterReading: number
  Minimum Value: -9.99999999999999E8

  Maximum Value: 9.99999999999999E8

  End Register Reading is the end register reading.

  Example: 11578.000000
• endRegisterReadingId: string
  Maximum Length: 12

  End Register Read ID is the unique identifier of the end register read.

  Example: 444074849655
• endRegisterReadTypeDescription: string
  Maximum Length: 150

  End Register Read Type Description
• finalServiceQuantityId: string
  Maximum Length: 30

  Final SQI is the final service quantity identifier of the calculation / audit read.

  Example: DAMT
• finalSqiDescription: string
  Maximum Length: 150

  Final SQI Description
• finalTimeOfUse: string
  Maximum Length: 30

  Final Time of Use is the final time-of-use code of the calculation / audit read.

  Example: ON
• finalTouDescription: string
  Maximum Length: 150

  Final TOU Description
• finalUnitOfMeasure: string
  Maximum Length: 30

  Final Unit of Measure is the final unit of measure of the calculation / audit read.

  Example: CF
• finalUomDescription: string
  Maximum Length: 150

  Final Uom Description
• howToUse: string
  Allowed Values: [ "+ ", "- ", "C ", "P " ]

  How To Use is a code that indicates if the "calculation / audit" read was is considered to be additive, subtractive, peak or check. * `+ ` - Additive, * `- ` - Subtractive, * `C ` - Check, * `P ` - Peak

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

  How To Use (SP) is the SA/SP's how to use code. * `+ ` - Add, * `- ` - Subtract, * `C ` - Check, * `S ` - Service Quantity, * `X ` - Calculation/Audit

  Example: +
• measuredQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive

  Example: 4377.000000
• measuresPeakQuantity: boolean
  Measures Peak Qty
• meterConfigurationId: string
  Maximum Length: 10

  Meter Configuration ID
• meterReadId: string
  Maximum Length: 12

  Meter Read ID

  Example: 8833057699
• multiplier: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.

  Example: 1.000000
• notAvailableConsumptionDescription: string
  Maximum Length: 150

  Not Available Consumption Description
• registerConstant: number
  Minimum Value: -999999.999999

  Maximum Value: 999999.999999

  Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.

  Example: 1.000000
• registerQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.

  Example: 200.000000
• sequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Sequence
• servicePointId: string
  Maximum Length: 10

  Service Point ID
• serviceQuantityIdentifier: string
  Maximum Length: 30

  SQI
• serviceQuantityIdentifier2: string
  Maximum Length: 30

  Service Quantity Identifier
• startMeterRead: string
  Maximum Length: 12

  Start meter read ID

  Example: 444074813104
• startReadDateTime: string (date-time)
  Start Read Date/Time is the date and time of the start meter read.

  Example: 1998-06-30T00:00:00-04:00
• startRegisterReadId: string
  Maximum Length: 12

  Start Register Read ID is the unique identifier of the start register read.

  Example: 444074862768
• startRegisterReading: number
  Minimum Value: -9.99999999999999E8

  Maximum Value: 9.99999999999999E8

  Start Register Reading is the start register reading.

  Example: 7201.000000
• startRegisterReadTypeDescription: string
  Maximum Length: 150

  Start Register Read Type Description
• timeOfUse: string
  Maximum Length: 30

  Time of Use
• timeOfUse2: string
  Maximum Length: 30

  Time of Use
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure
• unitOfMeasure2: string
  Maximum Length: 30

  Unit of Measure
• usePercent: number
  Minimum Value: -999

  Maximum Value: 999

  Use Percent is the percentage of the total consumption that was billed.

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

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "finalUnitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.",
            "example":"CF"
        },
        "finalTimeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Final Time of Use is the final time-of-use code of the calculation / audit read.",
            "example":"ON"
        },
        "finalServiceQuantityId":{
            "type":"string",
            "maxLength":30,
            "description":"Final SQI is the final service quantity identifier of the calculation / audit read.",
            "example":"DAMT"
        },
        "registerQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.",
            "example":"200.000000"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        },
        "meterConfigurationId":{
            "type":"string",
            "maxLength":10,
            "description":"Meter Configuration ID"
        },
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "serviceQuantityIdentifier":{
            "type":"string",
            "maxLength":30,
            "description":"SQI"
        },
        "startRegisterReading":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":-9.99999999999999E8,
            "description":"Start Register Reading is the start register reading.",
            "example":"7201.000000"
        },
        "endRegisterReading":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":-9.99999999999999E8,
            "description":"End Register Reading is the end register reading.",
            "example":"11578.000000"
        },
        "measuredQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive",
            "example":"4377.000000"
        },
        "registerConstant":{
            "type":"number",
            "maximum":999999.999999,
            "minimum":-999999.999999,
            "description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.",
            "example":"1.000000"
        },
        "howToUse":{
            "type":"string",
            "enum":[
                "+   ",
                "-   ",
                "C   ",
                "P   "
            ],
            "description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak",
            "example":"+"
        },
        "howToUseRead":{
            "type":"string",
            "enum":[
                "+   ",
                "-   ",
                "C   ",
                "S   ",
                "X   "
            ],
            "description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit",
            "example":"+"
        },
        "usePercent":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Use Percent is the percentage of the total consumption that was billed.",
            "example":"100"
        },
        "measuresPeakQuantity":{
            "type":"boolean",
            "description":"Measures Peak Qty"
        },
        "startReadDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start Read Date/Time is the date and time of the start meter read.",
            "example":"1998-06-30T00:00:00-04:00"
        },
        "endReadDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"End Read Date/Time is the date and time of the end meter read.",
            "example":"998-09-30T00:00:00-04:00"
        },
        "startRegisterReadId":{
            "type":"string",
            "maxLength":12,
            "description":"Start Register Read ID is the unique identifier of the start register read.",
            "example":"444074862768"
        },
        "endRegisterReadingId":{
            "type":"string",
            "maxLength":12,
            "description":"End Register Read ID is the unique identifier of the end register read.",
            "example":"444074849655"
        },
        "startRegisterReadTypeDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Start Register Read Type Description"
        },
        "endRegisterReadTypeDescription":{
            "type":"string",
            "maxLength":150,
            "description":"End Register Read Type Description"
        },
        "multiplier":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.",
            "example":"1.000000"
        },
        "consumptionType":{
            "type":"string",
            "enum":[
                "C   ",
                "S   "
            ],
            "description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive",
            "example":"S"
        },
        "notAvailableConsumptionDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Not Available Consumption Description"
        },
        "startMeterRead":{
            "type":"string",
            "maxLength":12,
            "description":"Start meter read ID",
            "example":"444074813104"
        },
        "endMeterRead":{
            "type":"string",
            "maxLength":12,
            "description":"End meter read ID",
            "example":"44074866808"
        },
        "meterReadId":{
            "type":"string",
            "maxLength":12,
            "description":"Meter Read ID",
            "example":"8833057699"
        },
        "unitOfMeasure2":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "serviceQuantityIdentifier2":{
            "type":"string",
            "maxLength":30,
            "description":"Service Quantity Identifier"
        },
        "timeOfUse2":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "finalUomDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Final Uom Description"
        },
        "finalSqiDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Final SQI Description"
        },
        "finalTouDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Final TOU Description"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use"
            },
            "serviceQuantityIdentifier":{
                "type":"string",
                "maxLength":30,
                "description":"SQI"
            },
            "initialServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
                "example":"470.762600"
            },
            "billableServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Billable Service Quantity"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billableServiceQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Billable Service Quantity
• initialServiceQuantity: number
  Minimum Value: -1.0E12

  Maximum Value: 1.0E12

  Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.

  Example: 470.762600
• serviceQuantityIdentifier: string
  Maximum Length: 30

  SQI
• timeOfUse: string
  Maximum Length: 30

  Time of Use
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "serviceQuantityIdentifier":{
            "type":"string",
            "maxLength":30,
            "description":"SQI"
        },
        "initialServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
            "example":"470.762600"
        },
        "billableServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Billable Service Quantity"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "currentAmount":{
                "type":"number",
                "description":"Current Amount"
            },
            "billSegmentStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "40  ",
                    "50  ",
                    "60  ",
                    "70  "
                ],
                "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billSegmentStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]

  Bill Segment Status: * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `40 ` - Pending Cancel, * `50 ` - Frozen, * `60 ` - Canceled, * `70 ` - OK
• currentAmount: number
  Current Amount

{
    "type":"object",
    "properties":{
        "currentAmount":{
            "type":"number",
            "description":"Current Amount"
        },
        "billSegmentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
        }
    }
}

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