Action Budget
patch
https://server:port/spl/rest/apis/customer/financials/budgets/{accountId}/lifecycle
This operation perform actions like recommend, cancel, and save on budget.
Request
Path Parameters
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID identifies the account of the customer for which the budget exists.Example:1112345900
-
action: string
Allowed Values:
[ "C1CN", "C1RC", "C1SV" ]
Available action for the budget. * `C1CN` - Cancel, * `C1RC` - Recommend Budget, * `C1SV` - Save -
budgetPlan: object
budgetPlan
Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.
-
currency: string
Maximum Length:
3
Currency Code -
newBudgetDate: string
(date)
Use New Budget Date to define the effective date of any changes to the customer's budget amount. This date is the effective date on the respective service agreements' recurring charge histories.Example:
2021-12-14
-
serviceAgreementsList: object
serviceAgreementsList
-
totalBudgetAmount: number
Total Budget Amount displays the sum of the service agreements' current budget amounts.Example:
252$
-
totalNewBudgetAmount: number
For accounts with a small number of service agreements, the system displays the sum of the service agreements' new budget amounts in Total New Budget.Example:
0.00$
Nested Schema : budgetPlan
Type:
object
Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.
Show Source
-
budgetPlan: string
Maximum Length:
8
Budget Plan
Nested Schema : items
Type:
Show Source
object
-
budgetAmount: number
Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.Example:
232.00
-
lastChangedDate: string
(date)
Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.Example:
2021-12-15
-
newBudgetAmount: number
New Budget
-
serviceAgreement: object
serviceAgreement
Nested Schema : serviceAgreement
Type:
Show Source
object
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID identifies the account of the customer for which the budget exists.Example:1112345900
-
action: string
Allowed Values:
[ "C1CN", "C1RC", "C1SV" ]
Available action for the budget. * `C1CN` - Cancel, * `C1RC` - Recommend Budget, * `C1SV` - Save -
budgetPlan: object
budgetPlan
Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.
-
currency: string
Maximum Length:
3
Currency Code -
newBudgetDate: string
(date)
Use New Budget Date to define the effective date of any changes to the customer's budget amount. This date is the effective date on the respective service agreements' recurring charge histories.Example:
2021-12-14
-
serviceAgreementsList: object
serviceAgreementsList
-
totalBudgetAmount: number
Total Budget Amount displays the sum of the service agreements' current budget amounts.Example:
252$
-
totalNewBudgetAmount: number
For accounts with a small number of service agreements, the system displays the sum of the service agreements' new budget amounts in Total New Budget.Example:
0.00$
Nested Schema : budgetPlan
Type:
object
Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.
Show Source
-
budgetPlan: string
Maximum Length:
8
Budget Plan
Nested Schema : items
Type:
Show Source
object
-
budgetAmount: number
Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.Example:
232.00
-
lastChangedDate: string
(date)
Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.Example:
2021-12-15
-
newBudgetAmount: number
New Budget
-
serviceAgreement: object
serviceAgreement
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 : C1BudgetDeta
Type:
Show Source
object
-
_self: string
_self
-
accountId: string
Maximum Length:
10
Account ID identifies the account of the customer for which the budget exists.Example:1112345900
-
action: string
Allowed Values:
[ "C1CN", "C1RC", "C1SV" ]
Available action for the budget. * `C1CN` - Cancel, * `C1RC` - Recommend Budget, * `C1SV` - Save -
budgetPlan: object
budgetPlan
Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.
-
currency: string
Maximum Length:
3
Currency Code -
newBudgetDate: string
(date)
Use New Budget Date to define the effective date of any changes to the customer's budget amount. This date is the effective date on the respective service agreements' recurring charge histories.Example:
2021-12-14
-
serviceAgreementsList: object
serviceAgreementsList
-
totalBudgetAmount: number
Total Budget Amount displays the sum of the service agreements' current budget amounts.Example:
252$
-
totalNewBudgetAmount: number
For accounts with a small number of service agreements, the system displays the sum of the service agreements' new budget amounts in Total New Budget.Example:
0.00$
Nested Schema : budgetPlan
Type:
object
Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how or when the customer's budget is periodically changed.
Show Source
-
_link: string
_link
-
budgetPlan: string
Maximum Length:
8
Budget Plan
Nested Schema : items
Type:
Show Source
object
-
budgetAmount: number
Budget Amount This is the existing budget amount, also referred to as the recurring charge amount, for the service agreement.Example:
232.00
-
lastChangedDate: string
(date)
Last Changed Date is the date when the service agreement's budget amount, also referred to as the recurring charge amount, was last changed.Example:
2021-12-15
-
newBudgetAmount: number
New Budget
-
serviceAgreement: object
serviceAgreement
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.