Action Bill Segment
patch
https://server:port/spl/rest/apis/customer/financials/billSegments/{billSegmentId}/lifecycle
This operation updates the Bill segment status for the provided Bill Segment Id.
Request
Path Parameters
-
billSegmentId(required): string
Bill Segment ID is the system-assigned unique identifier of the bill segment.Example:
211366855400
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
accountingDate: string
(date)
Accounting Date
-
action: string
Allowed Values:
[ "C1CN", "C1CR", "C1DE", "C1FR", "C1GN", "C1IC", "C1RB", "C1UD" ]
Available action for the bill segment. * `C1CN` - Cancel, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1IC` - Init Cancel, * `C1RB` - Rebill, * `C1UD` - UndoExample:C1CF
-
areEstimatesAllowed: boolean
Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.Example:
false
-
billSegment: object
billSegment
-
cancelReason: string
Maximum Length:
4
Cancel Reason defines why the bill segment(s) are being canceled.Example:Wrong read
-
cancelReasonDescription: string
Maximum Length:
100
Cancel Reason Description defines the reason why the bill segment(s) are being canceled.Example:Canceled prior to completion.
-
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
-
creditDate: string
(date)
Bill Date is the business date that was used when the bill was completed.Example:
06-05-2013
-
cutOffDate: string
(date)
Cutoff Date is the last day of the new bill segment.Example:
2021-10-05
-
hasBillingOption: boolean
Billing Option
Nested Schema : billSegment
Type:
Show Source
object
-
billSegmentId: string
Maximum Length:
12
Bill Segment ID is the system-assigned unique identifier of the bill segment.Example:211366855400
Root Schema : schema
Type:
Show Source
object
-
accountingDate: string
(date)
Accounting Date
-
action: string
Allowed Values:
[ "C1CN", "C1CR", "C1DE", "C1FR", "C1GN", "C1IC", "C1RB", "C1UD" ]
Available action for the bill segment. * `C1CN` - Cancel, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1IC` - Init Cancel, * `C1RB` - Rebill, * `C1UD` - UndoExample:C1CF
-
areEstimatesAllowed: boolean
Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.Example:
false
-
billSegment: object
billSegment
-
cancelReason: string
Maximum Length:
4
Cancel Reason defines why the bill segment(s) are being canceled.Example:Wrong read
-
cancelReasonDescription: string
Maximum Length:
100
Cancel Reason Description defines the reason why the bill segment(s) are being canceled.Example:Canceled prior to completion.
-
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
-
creditDate: string
(date)
Bill Date is the business date that was used when the bill was completed.Example:
06-05-2013
-
cutOffDate: string
(date)
Cutoff Date is the last day of the new bill segment.Example:
2021-10-05
-
hasBillingOption: boolean
Billing Option
Nested Schema : billSegment
Type:
Show Source
object
-
billSegmentId: string
Maximum Length:
12
Bill Segment ID is the system-assigned unique identifier of the bill segment.Example:211366855400
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1ActBillSeg
Type:
Show Source
object
-
action: string
Allowed Values:
[ "C1CN", "C1CR", "C1DE", "C1FR", "C1GN", "C1IC", "C1RB", "C1UD" ]
Available action for the bill segment. * `C1CN` - Cancel, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1IC` - Init Cancel, * `C1RB` - Rebill, * `C1UD` - UndoExample:C1CF
-
billSegment: object
billSegment
-
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 -
nextActions: array
nextActions
Nested Schema : billSegment
Type:
Show Source
object
-
_link: string
_link
-
billSegmentId: string
Maximum Length:
12
Bill Segment ID is the system-assigned unique identifier of the bill segment.Example:211366855400
Nested Schema : items
Type:
Show Source
object
-
action: string
Allowed Values:
[ "C1CN", "C1CR", "C1DE", "C1FR", "C1GN", "C1IC", "C1RB", "C1UD" ]
Available action for the bill segment. * `C1CN` - Cancel, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1IC` - Init Cancel, * `C1RB` - Rebill, * `C1UD` - UndoExample:C1CF
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.