Update Bill
put
https://server:port/spl/rest/apis/customer/financials/bills/{billId}
This Operation handles the Integration Suite API to Update Bill .
Request
Path Parameters
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
accountingDate: string
(date)
Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.Example:
2021-10-05
-
areEstimatesAllowed: boolean
Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.Example:
false
-
balancedAmount: number
Balanced Amount contains the total amount of financial transactions linked to this bill that are linked to balanced match events.Example:
0
-
billDate: string
(date)
Bill Date is the business date that was used when the bill was completed.Example:
2001-05-01
-
billId: string
Maximum Length:
12
Bill ID is the system-assigned unique identifier of the bill.Example:549133128888
-
billRoutings: object
billRoutings
-
billSegmentStatus: string
Maximum Length:
30
Bill Segment Status is the bill segment's status. -
billStatus: string
Allowed Values:
[ "C ", "P " ]
Bill Status is the bill's status * `C ` - Complete, * `P ` - PendingExample:C
-
cancelReason: string
Maximum Length:
4
Cancel Reason defines why the bill segment(s) are being canceled. -
characteristics: object
characteristics
-
completedDatetime: string
(date-time)
Completion Date/Time is the date and time on which the bill was completed.Example:
2002-10-24T16:51:56-04:00
-
creationDateTime: string
(date-time)
Create Date/Time is the date and time on which the bill was originally created.Example:
2002-10-24T16:51:58-04:00
-
creditNoteDate: string
(date)
Bill Date is the business date that was used when the bill was completed.
-
cutOffDate: string
(date)
Cutoff Date is the last possible day of each bill period for a bill segment.Example:
2021-10-05
-
disputedAmount: number
Disputed Amount contains the total amount of financial transactions linked to this bill that are linked to disputed match events.Example:
0
-
dueDate: string
(date)
Due Date is the date on which the bill is due.Example:
2001-05-01
-
fieldNamesForBillTotals: string
(fieldNamesForBillTotals)
-
fieldNamesForBillTotals10: string
(fieldNamesForBillTotals10)
-
fieldNamesForBillTotals2: string
(fieldNamesForBillTotals2)
-
fieldNamesForBillTotals3: string
(fieldNamesForBillTotals3)
-
fieldNamesForBillTotals4: string
(fieldNamesForBillTotals4)
-
fieldNamesForBillTotals5: string
(fieldNamesForBillTotals5)
-
fieldNamesForBillTotals6: string
(fieldNamesForBillTotals6)
-
fieldNamesForBillTotals7: string
(fieldNamesForBillTotals7)
-
fieldNamesForBillTotals8: string
(fieldNamesForBillTotals8)
-
fieldNamesForBillTotals9: string
(fieldNamesForBillTotals9)
-
fieldValueForBillTotals: number
(fieldValueForBillTotals)
-
fieldValueForBillTotals10: number
(fieldValueForBillTotals10)
-
fieldValueForBillTotals2: number
(fieldValueForBillTotals2)
-
fieldValueForBillTotals3: number
(fieldValueForBillTotals3)
-
fieldValueForBillTotals4: number
(fieldValueForBillTotals4)
-
fieldValueForBillTotals5: number
(fieldValueForBillTotals5)
-
fieldValueForBillTotals6: number
(fieldValueForBillTotals6)
-
fieldValueForBillTotals7: number
(fieldValueForBillTotals7)
-
fieldValueForBillTotals8: number
(fieldValueForBillTotals8)
-
fieldValueForBillTotals9: number
(fieldValueForBillTotals9)
-
hasBillingOption: boolean
Use the Billing Option to define how the system looks for meter reads.Example:
false
-
hasMore: boolean
(hasMore)
-
isLatePaymentCharge: boolean
Eligible for Late Payment Charge can be checked if a charge should be levied for late payment.Example:
false
-
isLatestBill: boolean
Latest BillExample:
false
-
latePaymentChargeDate: string
(date)
Late Payment Charge Date is the date on which the system will levy a late payment charge if payment is not received.Example:
2001-05-21
-
messages: object
messages
-
nextActions: object
nextActions
-
nextCreditReviewDate: string
(date)
Next Credit Review Date is the next date on which the account's debt will be reviewed by the account debt monitor.Example:
2001-05-21
-
numberOfBalancedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Balanced Item(s) contains the count of financial transactions linked to this bill that are linked to balanced match events.Example:0
-
numberOfDisputedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Disputed Item(s) contains the count of financial transactions linked to this bill that are linked to disputed match events.Example:0
-
numberOfUnbalancedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Unbalanced Item(s) contains the count of financial transactions linked to this bill that are linked to unbalanced match events.Example:0
-
numberOfUnmatchedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Unmatched Item(s) contains the count of financial transactions linked to this bill that are not linked to any match event.Example:0
-
openItemCurrentCharges: number
Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.Example:
0
-
openItemTotalAdjustments: number
Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.Example:
0
-
openItemTotalCorrections: number
Total Bill Corrections is the total amount of canceled and / or rebilled bill segment financial transactions linked to this billExample:
0
-
processDate: string
(date)
Process DateExample:
2021-10-05
-
segments: object
segments
-
totalAmount: number
The Total Amount contains the sum of the current amount of these bill segmentsExample:
0
-
totalGeneratedCharge: number
Minimum Value:
0
Maximum Value:0
Total Generated Charge represents the total amount of the bill segments.Example:35
-
totalRecordsCount: string
(totalRecordsCount)
-
unbalancedAmount: number
Unbalanced Amount contains total amount of financial transactions linked to this bill that are linked to unbalanced match events.Example:
0
-
unmatchedAmount: number
Unmatched Amount contains the total amount of financial transactions linked to this bill that are not linked to any match event.Example:
0
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : items
Type:
Show Source
object
-
addressInformation: object
addressInformation
-
billRoutingMethod: string
Allowed Values:
[ "EM ", "FX ", "P " ]
Bill Routing Method is the method used to transmit the bill to the customer. * `EM ` - Email, * `FX ` - Fax, * `P ` - PostalExample:EM
-
billRoutingParameters: object
billRoutingParameters
-
person: object
person
Nested Schema : addressInformation
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Address -
address2: string
Maximum Length:
254
The second line of the address. -
address3: string
Maximum Length:
254
The third line of the address. -
address4: string
Maximum Length:
254
The fourth line of the address. -
city: string
Maximum Length:
90
City -
country: object
country
-
county: string
Maximum Length:
90
The county of the address. -
geographicCode: string
Maximum Length:
15
Geographic code used to apply proper taxation rules to the physical address location. -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer ReferenceExample:House Type indicates the type of house.
-
inCityLimit: boolean
In City Limit
-
name1: string
Maximum Length:
254
Name 1 -
name2: string
Maximum Length:
254
Name 2 -
name3: string
Maximum Length:
254
Name 3 -
number1: string
Maximum Length:
6
Number 1 -
number2: string
Maximum Length:
4
Number 2 -
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
The state of the address.Example:CA
Nested Schema : billRoutingParameters
Type:
Show Source
object
-
batchControl: object
batchControl
-
batchNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Number is used to view information and statistics on the batch run's "threads".Example:223
-
billFormat: string
Allowed Values:
[ "D ", "S " ]
Bill Format Indicates if the customer should receive a detailed or a summary bill. * `D ` - Detailed, * `S ` - SummaryExample:D
-
billPrintIntercept: object
billPrintIntercept
-
billRouteType: object
billRouteType
-
copies: number
Minimum Value:
-99
Maximum Value:99
Number of Bill Copies -
customerPOId: string
Maximum Length:
20
PO ID is the purchase order Id the customer wants printed on their copy of the bill. -
doNotExtract: boolean
Turn on Do Not Extract if the bill should not be routed to the individual for whatever reason.Example:
false
-
isReprint: boolean
Reprint
-
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence is the system-assigned identifier assigned to this bill routing.Example:2
Nested Schema : batchControl
Type:
Show Source
object
-
batchControl: string
Maximum Length:
8
Batch Control
Nested Schema : billPrintIntercept
Type:
Show Source
object
-
billPrintIntercept: string
Maximum Length:
8
User
Nested Schema : billRouteType
Type:
Show Source
object
-
billRouteType: string
Maximum Length:
8
Bill Route Type
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
typeOfCharacteristicValue: string
Maximum Length:
4
Type of Char Value -
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
billMessageCode: object
billMessageCode
-
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:Please call (123) 111-9111 if you have any questions about your rate
-
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:10
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : billMessageCode
Type:
Show Source
object
-
billMessageCode: string
Maximum Length:
4
Bill Message
Nested Schema : items
Type:
Show Source
object
-
_link: string
(_link)
-
actionName: string
(actionName)
Nested Schema : items
Type:
Show Source
object
-
billingProcessSequence: number
Minimum Value:
-999999
Maximum Value:999999
Billing Processing Sequence -
billSegment: object
billSegment
-
currentAmount: number
Current Amount is the bill segment's effect on the service agreement's current balance.Example:
100
-
description: string
Maximum Length:
60
Description on Bill is the information about the bill line that appears on the customer's bill. -
endDate: string
(date)
Start Date - End Date is the portion of the bill segment period that the calculation details apply.
-
hasMore: boolean
(hasMore)
-
hasProcess: boolean
Process
-
isAccountingDate: boolean
Accounting Date is the date the system uses to determine the financial transaction's accounting period in your general ledger.
-
isCancelAfter: boolean
Canceled after completion appears if the bill segment was canceled after the bill was sent to the customer. The financial impact of this bill segment appears as a "bill correction" on the next bill produced for the customer.
-
isSATypeRequiresBillDeterminants: boolean
If the SA Type has a special role of Bill Determinants Required, you must enter the Cutoff Time and Start Day Option that is used on a bill determinants usage request.
-
messageInformation: string
Maximum Length:
150
Message Information -
premise: object
premise
-
rebill: string
Maximum Length:
30
Sometimes the error on a bill segment is not detected by the system and therefore the system freezes the bill segment and routes the bill to the customer. To correct such a bill segment, you must cancel the offending segment and create a new segment (after correcting the cause of the problem). This process is referred as cancel / rebill. -
serviceAgreement: object
serviceAgreement
-
serviceQuantity: number
Minimum Value:
-1.0E12
Maximum Value:1.0E12
Billable Service Quantity -
shouldProtectProcess: boolean
Protect Process
-
shouldRebillAfter: boolean
Rebill after completion appears if the bill segment is a rebill that was created after the bill was sent to the customer. The financial impact of this bill segment appears as a "bill correction" on the next bill produced for the customer.
-
startDate: string
(date)
Start Date - End Date is the portion of the bill segment period that the calculation details apply.
-
status: 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 -
totalRecordsCount: string
(totalRecordsCount)
-
transferDescription: string
Maximum Length:
30
Transfer Description -
unitOfMeasureDescription: string
Maximum Length:
30
Unit of Measure is the description for unit of measure of the service quantity.Example:Gallon
-
uom: string
Maximum Length:
30
Unit of Measure
Nested Schema : billSegment
Type:
Show Source
object
-
billSegmentId: string
Maximum Length:
12
Bill Segment ID
Nested Schema : serviceAgreement
Type:
Show Source
object
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
accountingDate: string
(date)
Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.Example:
2021-10-05
-
areEstimatesAllowed: boolean
Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.Example:
false
-
balancedAmount: number
Balanced Amount contains the total amount of financial transactions linked to this bill that are linked to balanced match events.Example:
0
-
billDate: string
(date)
Bill Date is the business date that was used when the bill was completed.Example:
2001-05-01
-
billId: string
Maximum Length:
12
Bill ID is the system-assigned unique identifier of the bill.Example:549133128888
-
billRoutings: object
billRoutings
-
billSegmentStatus: string
Maximum Length:
30
Bill Segment Status is the bill segment's status. -
billStatus: string
Allowed Values:
[ "C ", "P " ]
Bill Status is the bill's status * `C ` - Complete, * `P ` - PendingExample:C
-
cancelReason: string
Maximum Length:
4
Cancel Reason defines why the bill segment(s) are being canceled. -
characteristics: object
characteristics
-
completedDatetime: string
(date-time)
Completion Date/Time is the date and time on which the bill was completed.Example:
2002-10-24T16:51:56-04:00
-
creationDateTime: string
(date-time)
Create Date/Time is the date and time on which the bill was originally created.Example:
2002-10-24T16:51:58-04:00
-
creditNoteDate: string
(date)
Bill Date is the business date that was used when the bill was completed.
-
cutOffDate: string
(date)
Cutoff Date is the last possible day of each bill period for a bill segment.Example:
2021-10-05
-
disputedAmount: number
Disputed Amount contains the total amount of financial transactions linked to this bill that are linked to disputed match events.Example:
0
-
dueDate: string
(date)
Due Date is the date on which the bill is due.Example:
2001-05-01
-
fieldNamesForBillTotals: string
(fieldNamesForBillTotals)
-
fieldNamesForBillTotals10: string
(fieldNamesForBillTotals10)
-
fieldNamesForBillTotals2: string
(fieldNamesForBillTotals2)
-
fieldNamesForBillTotals3: string
(fieldNamesForBillTotals3)
-
fieldNamesForBillTotals4: string
(fieldNamesForBillTotals4)
-
fieldNamesForBillTotals5: string
(fieldNamesForBillTotals5)
-
fieldNamesForBillTotals6: string
(fieldNamesForBillTotals6)
-
fieldNamesForBillTotals7: string
(fieldNamesForBillTotals7)
-
fieldNamesForBillTotals8: string
(fieldNamesForBillTotals8)
-
fieldNamesForBillTotals9: string
(fieldNamesForBillTotals9)
-
fieldValueForBillTotals: number
(fieldValueForBillTotals)
-
fieldValueForBillTotals10: number
(fieldValueForBillTotals10)
-
fieldValueForBillTotals2: number
(fieldValueForBillTotals2)
-
fieldValueForBillTotals3: number
(fieldValueForBillTotals3)
-
fieldValueForBillTotals4: number
(fieldValueForBillTotals4)
-
fieldValueForBillTotals5: number
(fieldValueForBillTotals5)
-
fieldValueForBillTotals6: number
(fieldValueForBillTotals6)
-
fieldValueForBillTotals7: number
(fieldValueForBillTotals7)
-
fieldValueForBillTotals8: number
(fieldValueForBillTotals8)
-
fieldValueForBillTotals9: number
(fieldValueForBillTotals9)
-
hasBillingOption: boolean
Use the Billing Option to define how the system looks for meter reads.Example:
false
-
hasMore: boolean
(hasMore)
-
isLatePaymentCharge: boolean
Eligible for Late Payment Charge can be checked if a charge should be levied for late payment.Example:
false
-
isLatestBill: boolean
Latest BillExample:
false
-
latePaymentChargeDate: string
(date)
Late Payment Charge Date is the date on which the system will levy a late payment charge if payment is not received.Example:
2001-05-21
-
messages: object
messages
-
nextActions: object
nextActions
-
nextCreditReviewDate: string
(date)
Next Credit Review Date is the next date on which the account's debt will be reviewed by the account debt monitor.Example:
2001-05-21
-
numberOfBalancedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Balanced Item(s) contains the count of financial transactions linked to this bill that are linked to balanced match events.Example:0
-
numberOfDisputedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Disputed Item(s) contains the count of financial transactions linked to this bill that are linked to disputed match events.Example:0
-
numberOfUnbalancedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Unbalanced Item(s) contains the count of financial transactions linked to this bill that are linked to unbalanced match events.Example:0
-
numberOfUnmatchedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Unmatched Item(s) contains the count of financial transactions linked to this bill that are not linked to any match event.Example:0
-
openItemCurrentCharges: number
Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.Example:
0
-
openItemTotalAdjustments: number
Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.Example:
0
-
openItemTotalCorrections: number
Total Bill Corrections is the total amount of canceled and / or rebilled bill segment financial transactions linked to this billExample:
0
-
processDate: string
(date)
Process DateExample:
2021-10-05
-
segments: object
segments
-
totalAmount: number
The Total Amount contains the sum of the current amount of these bill segmentsExample:
0
-
totalGeneratedCharge: number
Minimum Value:
0
Maximum Value:0
Total Generated Charge represents the total amount of the bill segments.Example:35
-
totalRecordsCount: string
(totalRecordsCount)
-
unbalancedAmount: number
Unbalanced Amount contains total amount of financial transactions linked to this bill that are linked to unbalanced match events.Example:
0
-
unmatchedAmount: number
Unmatched Amount contains the total amount of financial transactions linked to this bill that are not linked to any match event.Example:
0
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : items
Type:
Show Source
object
-
addressInformation: object
addressInformation
-
billRoutingMethod: string
Allowed Values:
[ "EM ", "FX ", "P " ]
Bill Routing Method is the method used to transmit the bill to the customer. * `EM ` - Email, * `FX ` - Fax, * `P ` - PostalExample:EM
-
billRoutingParameters: object
billRoutingParameters
-
person: object
person
Nested Schema : addressInformation
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Address -
address2: string
Maximum Length:
254
The second line of the address. -
address3: string
Maximum Length:
254
The third line of the address. -
address4: string
Maximum Length:
254
The fourth line of the address. -
city: string
Maximum Length:
90
City -
country: object
country
-
county: string
Maximum Length:
90
The county of the address. -
geographicCode: string
Maximum Length:
15
Geographic code used to apply proper taxation rules to the physical address location. -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer ReferenceExample:House Type indicates the type of house.
-
inCityLimit: boolean
In City Limit
-
name1: string
Maximum Length:
254
Name 1 -
name2: string
Maximum Length:
254
Name 2 -
name3: string
Maximum Length:
254
Name 3 -
number1: string
Maximum Length:
6
Number 1 -
number2: string
Maximum Length:
4
Number 2 -
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
The state of the address.Example:CA
Nested Schema : billRoutingParameters
Type:
Show Source
object
-
batchControl: object
batchControl
-
batchNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Number is used to view information and statistics on the batch run's "threads".Example:223
-
billFormat: string
Allowed Values:
[ "D ", "S " ]
Bill Format Indicates if the customer should receive a detailed or a summary bill. * `D ` - Detailed, * `S ` - SummaryExample:D
-
billPrintIntercept: object
billPrintIntercept
-
billRouteType: object
billRouteType
-
copies: number
Minimum Value:
-99
Maximum Value:99
Number of Bill Copies -
customerPOId: string
Maximum Length:
20
PO ID is the purchase order Id the customer wants printed on their copy of the bill. -
doNotExtract: boolean
Turn on Do Not Extract if the bill should not be routed to the individual for whatever reason.Example:
false
-
isReprint: boolean
Reprint
-
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence is the system-assigned identifier assigned to this bill routing.Example:2
Nested Schema : batchControl
Type:
Show Source
object
-
batchControl: string
Maximum Length:
8
Batch Control
Nested Schema : billPrintIntercept
Type:
Show Source
object
-
billPrintIntercept: string
Maximum Length:
8
User
Nested Schema : billRouteType
Type:
Show Source
object
-
billRouteType: string
Maximum Length:
8
Bill Route Type
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
typeOfCharacteristicValue: string
Maximum Length:
4
Type of Char Value -
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
billMessageCode: object
billMessageCode
-
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:Please call (123) 111-9111 if you have any questions about your rate
-
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:10
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : billMessageCode
Type:
Show Source
object
-
billMessageCode: string
Maximum Length:
4
Bill Message
Nested Schema : items
Type:
Show Source
object
-
_link: string
(_link)
-
actionName: string
(actionName)
Nested Schema : items
Type:
Show Source
object
-
billingProcessSequence: number
Minimum Value:
-999999
Maximum Value:999999
Billing Processing Sequence -
billSegment: object
billSegment
-
currentAmount: number
Current Amount is the bill segment's effect on the service agreement's current balance.Example:
100
-
description: string
Maximum Length:
60
Description on Bill is the information about the bill line that appears on the customer's bill. -
endDate: string
(date)
Start Date - End Date is the portion of the bill segment period that the calculation details apply.
-
hasMore: boolean
(hasMore)
-
hasProcess: boolean
Process
-
isAccountingDate: boolean
Accounting Date is the date the system uses to determine the financial transaction's accounting period in your general ledger.
-
isCancelAfter: boolean
Canceled after completion appears if the bill segment was canceled after the bill was sent to the customer. The financial impact of this bill segment appears as a "bill correction" on the next bill produced for the customer.
-
isSATypeRequiresBillDeterminants: boolean
If the SA Type has a special role of Bill Determinants Required, you must enter the Cutoff Time and Start Day Option that is used on a bill determinants usage request.
-
messageInformation: string
Maximum Length:
150
Message Information -
premise: object
premise
-
rebill: string
Maximum Length:
30
Sometimes the error on a bill segment is not detected by the system and therefore the system freezes the bill segment and routes the bill to the customer. To correct such a bill segment, you must cancel the offending segment and create a new segment (after correcting the cause of the problem). This process is referred as cancel / rebill. -
serviceAgreement: object
serviceAgreement
-
serviceQuantity: number
Minimum Value:
-1.0E12
Maximum Value:1.0E12
Billable Service Quantity -
shouldProtectProcess: boolean
Protect Process
-
shouldRebillAfter: boolean
Rebill after completion appears if the bill segment is a rebill that was created after the bill was sent to the customer. The financial impact of this bill segment appears as a "bill correction" on the next bill produced for the customer.
-
startDate: string
(date)
Start Date - End Date is the portion of the bill segment period that the calculation details apply.
-
status: 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 -
totalRecordsCount: string
(totalRecordsCount)
-
transferDescription: string
Maximum Length:
30
Transfer Description -
unitOfMeasureDescription: string
Maximum Length:
30
Unit of Measure is the description for unit of measure of the service quantity.Example:Gallon
-
uom: string
Maximum Length:
30
Unit of Measure
Nested Schema : billSegment
Type:
Show Source
object
-
billSegmentId: string
Maximum Length:
12
Bill Segment ID
Nested Schema : serviceAgreement
Type:
Show Source
object
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : UPDATEBILL
Type:
Show Source
object
-
_self: string
_self
-
account: object
account
-
accountingDate: string
(date)
Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.Example:
2021-10-05
-
areEstimatesAllowed: boolean
Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.Example:
false
-
balancedAmount: number
Balanced Amount contains the total amount of financial transactions linked to this bill that are linked to balanced match events.Example:
0
-
billDate: string
(date)
Bill Date is the business date that was used when the bill was completed.Example:
2001-05-01
-
billId: string
Maximum Length:
12
Bill ID is the system-assigned unique identifier of the bill.Example:549133128888
-
billRoutings: object
billRoutings
-
billSegmentStatus: string
Maximum Length:
30
Bill Segment Status is the bill segment's status. -
billStatus: string
Allowed Values:
[ "C ", "P " ]
Bill Status is the bill's status * `C ` - Complete, * `P ` - PendingExample:C
-
cancelReason: string
Maximum Length:
4
Cancel Reason defines why the bill segment(s) are being canceled. -
characteristics: object
characteristics
-
completedDatetime: string
(date-time)
Completion Date/Time is the date and time on which the bill was completed.Example:
2002-10-24T16:51:56-04:00
-
creationDateTime: string
(date-time)
Create Date/Time is the date and time on which the bill was originally created.Example:
2002-10-24T16:51:58-04:00
-
creditNoteDate: string
(date)
Bill Date is the business date that was used when the bill was completed.
-
cutOffDate: string
(date)
Cutoff Date is the last possible day of each bill period for a bill segment.Example:
2021-10-05
-
disputedAmount: number
Disputed Amount contains the total amount of financial transactions linked to this bill that are linked to disputed match events.Example:
0
-
dueDate: string
(date)
Due Date is the date on which the bill is due.Example:
2001-05-01
-
fieldNamesForBillTotals: string
(fieldNamesForBillTotals)
-
fieldNamesForBillTotals10: string
(fieldNamesForBillTotals10)
-
fieldNamesForBillTotals2: string
(fieldNamesForBillTotals2)
-
fieldNamesForBillTotals3: string
(fieldNamesForBillTotals3)
-
fieldNamesForBillTotals4: string
(fieldNamesForBillTotals4)
-
fieldNamesForBillTotals5: string
(fieldNamesForBillTotals5)
-
fieldNamesForBillTotals6: string
(fieldNamesForBillTotals6)
-
fieldNamesForBillTotals7: string
(fieldNamesForBillTotals7)
-
fieldNamesForBillTotals8: string
(fieldNamesForBillTotals8)
-
fieldNamesForBillTotals9: string
(fieldNamesForBillTotals9)
-
fieldValueForBillTotals: number
(fieldValueForBillTotals)
-
fieldValueForBillTotals10: number
(fieldValueForBillTotals10)
-
fieldValueForBillTotals2: number
(fieldValueForBillTotals2)
-
fieldValueForBillTotals3: number
(fieldValueForBillTotals3)
-
fieldValueForBillTotals4: number
(fieldValueForBillTotals4)
-
fieldValueForBillTotals5: number
(fieldValueForBillTotals5)
-
fieldValueForBillTotals6: number
(fieldValueForBillTotals6)
-
fieldValueForBillTotals7: number
(fieldValueForBillTotals7)
-
fieldValueForBillTotals8: number
(fieldValueForBillTotals8)
-
fieldValueForBillTotals9: number
(fieldValueForBillTotals9)
-
hasBillingOption: boolean
Use the Billing Option to define how the system looks for meter reads.Example:
false
-
hasMore: boolean
(hasMore)
-
isLatePaymentCharge: boolean
Eligible for Late Payment Charge can be checked if a charge should be levied for late payment.Example:
false
-
isLatestBill: boolean
Latest BillExample:
false
-
latePaymentChargeDate: string
(date)
Late Payment Charge Date is the date on which the system will levy a late payment charge if payment is not received.Example:
2001-05-21
-
messages: object
messages
-
nextActions: object
nextActions
-
nextCreditReviewDate: string
(date)
Next Credit Review Date is the next date on which the account's debt will be reviewed by the account debt monitor.Example:
2001-05-21
-
numberOfBalancedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Balanced Item(s) contains the count of financial transactions linked to this bill that are linked to balanced match events.Example:0
-
numberOfDisputedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Disputed Item(s) contains the count of financial transactions linked to this bill that are linked to disputed match events.Example:0
-
numberOfUnbalancedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Unbalanced Item(s) contains the count of financial transactions linked to this bill that are linked to unbalanced match events.Example:0
-
numberOfUnmatchedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Unmatched Item(s) contains the count of financial transactions linked to this bill that are not linked to any match event.Example:0
-
openItemCurrentCharges: number
Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.Example:
0
-
openItemTotalAdjustments: number
Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.Example:
0
-
openItemTotalCorrections: number
Total Bill Corrections is the total amount of canceled and / or rebilled bill segment financial transactions linked to this billExample:
0
-
processDate: string
(date)
Process DateExample:
2021-10-05
-
segments: object
segments
-
totalAmount: number
The Total Amount contains the sum of the current amount of these bill segmentsExample:
0
-
totalGeneratedCharge: number
Minimum Value:
0
Maximum Value:0
Total Generated Charge represents the total amount of the bill segments.Example:35
-
totalRecordsCount: string
(totalRecordsCount)
-
unbalancedAmount: number
Unbalanced Amount contains total amount of financial transactions linked to this bill that are linked to unbalanced match events.Example:
0
-
unmatchedAmount: number
Unmatched Amount contains the total amount of financial transactions linked to this bill that are not linked to any match event.Example:
0
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID
Nested Schema : items
Type:
Show Source
object
-
addressInformation: object
addressInformation
-
billRoutingMethod: string
Allowed Values:
[ "EM ", "FX ", "P " ]
Bill Routing Method is the method used to transmit the bill to the customer. * `EM ` - Email, * `FX ` - Fax, * `P ` - PostalExample:EM
-
billRoutingParameters: object
billRoutingParameters
-
person: object
person
Nested Schema : addressInformation
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Address -
address2: string
Maximum Length:
254
The second line of the address. -
address3: string
Maximum Length:
254
The third line of the address. -
address4: string
Maximum Length:
254
The fourth line of the address. -
city: string
Maximum Length:
90
City -
country: object
country
-
county: string
Maximum Length:
90
The county of the address. -
geographicCode: string
Maximum Length:
15
Geographic code used to apply proper taxation rules to the physical address location. -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer ReferenceExample:House Type indicates the type of house.
-
inCityLimit: boolean
In City Limit
-
name1: string
Maximum Length:
254
Name 1 -
name2: string
Maximum Length:
254
Name 2 -
name3: string
Maximum Length:
254
Name 3 -
number1: string
Maximum Length:
6
Number 1 -
number2: string
Maximum Length:
4
Number 2 -
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
The state of the address.Example:CA
Nested Schema : billRoutingParameters
Type:
Show Source
object
-
batchControl: object
batchControl
-
batchNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Number is used to view information and statistics on the batch run's "threads".Example:223
-
billFormat: string
Allowed Values:
[ "D ", "S " ]
Bill Format Indicates if the customer should receive a detailed or a summary bill. * `D ` - Detailed, * `S ` - SummaryExample:D
-
billPrintIntercept: object
billPrintIntercept
-
billRouteType: object
billRouteType
-
copies: number
Minimum Value:
-99
Maximum Value:99
Number of Bill Copies -
customerPOId: string
Maximum Length:
20
PO ID is the purchase order Id the customer wants printed on their copy of the bill. -
doNotExtract: boolean
Turn on Do Not Extract if the bill should not be routed to the individual for whatever reason.Example:
false
-
isReprint: boolean
Reprint
-
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence is the system-assigned identifier assigned to this bill routing.Example:2
Nested Schema : person
Type:
Show Source
object
-
_link: string
_link
-
personId: string
Maximum Length:
10
Person ID
Nested Schema : country
Type:
Show Source
object
-
_link: string
_link
-
country: string
Maximum Length:
3
Country
Nested Schema : batchControl
Type:
Show Source
object
-
_link: string
_link
-
batchControl: string
Maximum Length:
8
Batch Control
Nested Schema : billPrintIntercept
Type:
Show Source
object
-
_link: string
_link
-
billPrintIntercept: string
Maximum Length:
8
User
Nested Schema : billRouteType
Type:
Show Source
object
-
_link: string
_link
-
billRouteType: string
Maximum Length:
8
Bill Route Type
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
typeOfCharacteristicValue: string
Maximum Length:
4
Type of Char Value -
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : characteristicType
Type:
Show Source
object
-
_link: string
_link
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
billMessageCode: object
billMessageCode
-
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:Please call (123) 111-9111 if you have any questions about your rate
-
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:10
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : billMessageCode
Type:
Show Source
object
-
_link: string
_link
-
billMessageCode: string
Maximum Length:
4
Bill Message
Nested Schema : items
Type:
Show Source
object
-
_link: string
(_link)
-
actionName: string
(actionName)
Nested Schema : items
Type:
Show Source
object
-
billingProcessSequence: number
Minimum Value:
-999999
Maximum Value:999999
Billing Processing Sequence -
billSegment: object
billSegment
-
currentAmount: number
Current Amount is the bill segment's effect on the service agreement's current balance.Example:
100
-
description: string
Maximum Length:
60
Description on Bill is the information about the bill line that appears on the customer's bill. -
endDate: string
(date)
Start Date - End Date is the portion of the bill segment period that the calculation details apply.
-
hasMore: boolean
(hasMore)
-
hasProcess: boolean
Process
-
isAccountingDate: boolean
Accounting Date is the date the system uses to determine the financial transaction's accounting period in your general ledger.
-
isCancelAfter: boolean
Canceled after completion appears if the bill segment was canceled after the bill was sent to the customer. The financial impact of this bill segment appears as a "bill correction" on the next bill produced for the customer.
-
isSATypeRequiresBillDeterminants: boolean
If the SA Type has a special role of Bill Determinants Required, you must enter the Cutoff Time and Start Day Option that is used on a bill determinants usage request.
-
messageInformation: string
Maximum Length:
150
Message Information -
premise: object
premise
-
rebill: string
Maximum Length:
30
Sometimes the error on a bill segment is not detected by the system and therefore the system freezes the bill segment and routes the bill to the customer. To correct such a bill segment, you must cancel the offending segment and create a new segment (after correcting the cause of the problem). This process is referred as cancel / rebill. -
serviceAgreement: object
serviceAgreement
-
serviceQuantity: number
Minimum Value:
-1.0E12
Maximum Value:1.0E12
Billable Service Quantity -
shouldProtectProcess: boolean
Protect Process
-
shouldRebillAfter: boolean
Rebill after completion appears if the bill segment is a rebill that was created after the bill was sent to the customer. The financial impact of this bill segment appears as a "bill correction" on the next bill produced for the customer.
-
startDate: string
(date)
Start Date - End Date is the portion of the bill segment period that the calculation details apply.
-
status: 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 -
totalRecordsCount: string
(totalRecordsCount)
-
transferDescription: string
Maximum Length:
30
Transfer Description -
unitOfMeasureDescription: string
Maximum Length:
30
Unit of Measure is the description for unit of measure of the service quantity.Example:Gallon
-
uom: string
Maximum Length:
30
Unit of Measure
Nested Schema : billSegment
Type:
Show Source
object
-
_link: string
_link
-
billSegmentId: string
Maximum Length:
12
Bill Segment ID
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
premiseId: string
Maximum Length:
10
Premise ID
Nested Schema : serviceAgreement
Type:
Show Source
object
-
_link: string
_link
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
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.