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
Root Schema : schema
Type:
Show Source
object
-
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 ` - PendingExample: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 ` - PutExample: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 SAExample:PROP
-
statusChangeDateTime: string
(date-time)
Bill Segment's status change date/timeExample:
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 DateExample:
12-03-2013
Nested Schema : account
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID identifies the customer who is responsible for the bill.Example:1112345900
Nested Schema : bill
Type:
Show Source
object
-
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
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)
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
Nested Schema : exception
Type:
Show Source
object
-
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
Nested Schema : premise
Type:
Show Source
object
-
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.
Nested Schema : quote
Type:
Show Source
object
-
quoteId: string
Maximum Length:
12
Quote ID is the system-assigned unique identifier of the quote.
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
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : billableCharge
Type:
Show Source
object
-
billableChargeId: string
Maximum Length:
12
Billable Charge ID
Nested Schema : items
Type:
Show Source
object
-
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 existsExample:
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
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : distributionCode
Type:
Show Source
object
-
distributionCode: string
Maximum Length:
10
Distribution Code
Nested Schema : items
Type:
Show Source
object
-
_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 CancellationExample: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
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
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 -- HighestExample:20
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
consumptionType: string
Allowed Values:
[ "C ", "S " ]
Consumptive/Subtractive flag shows if the register is consumptive or subtractive. * `C ` - Consumptive, * `S ` - SubtractiveExample:S
-
endMeterRead: string
Maximum Length:
12
End meter read IDExample: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 ` - PeakExample:+
-
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/AuditExample:+
-
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 subtractiveExample:4377.000000
-
measuresPeakQuantity: boolean
Measures Peak Qty
-
meterConfigurationId: string
Maximum Length:
10
Meter Configuration ID -
meterReadId: string
Maximum Length:
12
Meter Read IDExample: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 IDExample: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
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
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
Root Schema : schema
Type:
Show Source
object
-
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 ` - PendingExample: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 ` - PutExample: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 SAExample:PROP
-
statusChangeDateTime: string
(date-time)
Bill Segment's status change date/timeExample:
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 DateExample:
12-03-2013
Nested Schema : account
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID identifies the customer who is responsible for the bill.Example:1112345900
Nested Schema : bill
Type:
Show Source
object
-
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
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)
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
Nested Schema : exception
Type:
Show Source
object
-
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
Nested Schema : premise
Type:
Show Source
object
-
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.
Nested Schema : quote
Type:
Show Source
object
-
quoteId: string
Maximum Length:
12
Quote ID is the system-assigned unique identifier of the quote.
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
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : billableCharge
Type:
Show Source
object
-
billableChargeId: string
Maximum Length:
12
Billable Charge ID
Nested Schema : items
Type:
Show Source
object
-
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 existsExample:
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
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : distributionCode
Type:
Show Source
object
-
distributionCode: string
Maximum Length:
10
Distribution Code
Nested Schema : items
Type:
Show Source
object
-
_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 CancellationExample: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
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
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 -- HighestExample:20
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
consumptionType: string
Allowed Values:
[ "C ", "S " ]
Consumptive/Subtractive flag shows if the register is consumptive or subtractive. * `C ` - Consumptive, * `S ` - SubtractiveExample:S
-
endMeterRead: string
Maximum Length:
12
End meter read IDExample: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 ` - PeakExample:+
-
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/AuditExample:+
-
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 subtractiveExample:4377.000000
-
measuresPeakQuantity: boolean
Measures Peak Qty
-
meterConfigurationId: string
Maximum Length:
10
Meter Configuration ID -
meterReadId: string
Maximum Length:
12
Meter Read IDExample: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 IDExample: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
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
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
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1-BillSegm
Type:
Show Source
object
-
_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 ` - PendingExample: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 ` - PutExample: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 SAExample:PROP
-
statusChangeDateTime: string
(date-time)
Bill Segment's status change date/timeExample:
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 DateExample:
12-03-2013
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID identifies the customer who is responsible for the bill.Example:1112345900
Nested Schema : bill
Type:
Show Source
object
-
_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
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)
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
Nested Schema : currency
Type:
Show Source
object
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : exception
Type:
Show Source
object
-
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
Nested Schema : premise
Type:
Show Source
object
-
_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.
Nested Schema : quote
Type:
Show Source
object
-
_link: string
_link
-
quoteId: string
Maximum Length:
12
Quote ID is the system-assigned unique identifier of the quote.
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
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : billableCharge
Type:
Show Source
object
-
_link: string
_link
-
billableChargeId: string
Maximum Length:
12
Billable Charge ID
Nested Schema : items
Type:
Show Source
object
-
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 existsExample:
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
Nested Schema : characteristicType
Type:
Show Source
object
-
_link: string
_link
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : distributionCode
Type:
Show Source
object
-
_link: string
_link
-
distributionCode: string
Maximum Length:
10
Distribution Code
Nested Schema : items
Type:
Show Source
object
-
_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 CancellationExample: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
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : item
Type:
Show Source
object
-
_link: string
_link
-
item: string
Maximum Length:
10
Item ID
Nested Schema : items
Type:
Show Source
object
-
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 -- HighestExample:20
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
consumptionType: string
Allowed Values:
[ "C ", "S " ]
Consumptive/Subtractive flag shows if the register is consumptive or subtractive. * `C ` - Consumptive, * `S ` - SubtractiveExample:S
-
endMeterRead: string
Maximum Length:
12
End meter read IDExample: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 ` - PeakExample:+
-
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/AuditExample:+
-
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 subtractiveExample:4377.000000
-
measuresPeakQuantity: boolean
Measures Peak Qty
-
meterConfigurationId: string
Maximum Length:
10
Meter Configuration ID -
meterReadId: string
Maximum Length:
12
Meter Read IDExample: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 IDExample: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
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
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
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.