Action Bill
patch
https://server:port/spl/rest/apis/customer/financials/bills/{billId}/action
This Operation handles the Integration Suite API to Action Bill.
Note: All REST services that are in the Integration Suite APIs Web Service Categories require the related Integration Suite add-on product option to use.
Request
Path Parameters
Query Parameters
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
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
-
billDate2: string
(date)
Bill Date is the business date that was used when the bill was completed.
-
billId: string
Maximum Length:
12
Bill ID is the system-assigned unique identifier of the bill.Example:549133128888
-
cancelReason: string
Maximum Length:
4
Cancel Reason defines why the bill segment(s) are being canceled. -
creditNoteDate: string
(date)
ILM Date
-
cutOffDate: string
(date)
Cutoff Date is the last possible day of each bill period for a bill segment.Example:
2021-10-05
-
hasBillingOption: boolean
Use the Billing Option to define how the system looks for meter reads.Example:
false
-
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
-
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
-
billDate2: string
(date)
Bill Date is the business date that was used when the bill was completed.
-
billId: string
Maximum Length:
12
Bill ID is the system-assigned unique identifier of the bill.Example:549133128888
-
cancelReason: string
Maximum Length:
4
Cancel Reason defines why the bill segment(s) are being canceled. -
creditNoteDate: string
(date)
ILM Date
-
cutOffDate: string
(date)
Cutoff Date is the last possible day of each bill period for a bill segment.Example:
2021-10-05
-
hasBillingOption: boolean
Use the Billing Option to define how the system looks for meter reads.Example:
false
-
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 : ACTIONBILL
Type:
Show Source
object
-
_self: string
_self
-
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
-
billDate2: string
(date)
Bill Date is the business date that was used when the bill was completed.
-
billId: string
Maximum Length:
12
Bill ID is the system-assigned unique identifier of the bill.Example:549133128888
-
cancelReason: string
Maximum Length:
4
Cancel Reason defines why the bill segment(s) are being canceled. -
creditNoteDate: string
(date)
ILM Date
-
cutOffDate: string
(date)
Cutoff Date is the last possible day of each bill period for a bill segment.Example:
2021-10-05
-
hasBillingOption: boolean
Use the Billing Option to define how the system looks for meter reads.Example:
false
-
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.