Action Bill Segment
patch
https://server:port/spl/rest/apis/customer/financials/billSegments/{billSegmentId}/action
This operation handles the Integration Suite API to Action Bill Segment.
Request
Path Parameters
Query Parameters
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
_self: string
(_self)
-
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
-
billSegmentId: string
Maximum Length:
12
Bill Segment ID is the system-assigned unique identifier of the bill segment.Example:211366855400
-
cancelReason: string
Maximum Length:
4
Cancel Reason defines why the bill segment(s) are being canceled.Example:Wrong read
-
cancelReasonDescription: string
(cancelReasonDescription)
-
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
If the service agreements use meter reads, use the Billing Option to control how the system retrieves meter reads that appear on the bill. Select Use Schedule if the system should select reads based on the SA's SP's service cycle schedule. Select Use Cut off Date if the system should only select reads from the end date of the existing bill segment.Example:
true
-
name: string
(name)
-
nextActions: object
nextActions
Nested Schema : items
Type:
Show Source
object
-
_link: string
(_link)
-
actionName: string
(actionName)
Root Schema : schema
Type:
Show Source
object
-
_self: string
(_self)
-
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
-
billSegmentId: string
Maximum Length:
12
Bill Segment ID is the system-assigned unique identifier of the bill segment.Example:211366855400
-
cancelReason: string
Maximum Length:
4
Cancel Reason defines why the bill segment(s) are being canceled.Example:Wrong read
-
cancelReasonDescription: string
(cancelReasonDescription)
-
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
If the service agreements use meter reads, use the Billing Option to control how the system retrieves meter reads that appear on the bill. Select Use Schedule if the system should select reads based on the SA's SP's service cycle schedule. Select Use Cut off Date if the system should only select reads from the end date of the existing bill segment.Example:
true
-
name: string
(name)
-
nextActions: object
nextActions
Nested Schema : items
Type:
Show Source
object
-
_link: string
(_link)
-
actionName: string
(actionName)
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1-ActionBSe
Type:
Show Source
object
-
_self: string
(_self)
-
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
-
billSegmentId: string
Maximum Length:
12
Bill Segment ID is the system-assigned unique identifier of the bill segment.Example:211366855400
-
cancelReason: string
Maximum Length:
4
Cancel Reason defines why the bill segment(s) are being canceled.Example:Wrong read
-
cancelReasonDescription: string
(cancelReasonDescription)
-
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
If the service agreements use meter reads, use the Billing Option to control how the system retrieves meter reads that appear on the bill. Select Use Schedule if the system should select reads based on the SA's SP's service cycle schedule. Select Use Cut off Date if the system should only select reads from the end date of the existing bill segment.Example:
true
-
name: string
(name)
-
nextActions: object
nextActions
Nested Schema : items
Type:
Show Source
object
-
_link: string
(_link)
-
actionName: string
(actionName)
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.