Get Billing Account Context
get
/rest/apis/customer/v-model/billingContext/accountContext/{accountId}
Request
Path Parameters
-
accountId(required): string
Account ID identifies the customer who is responsible for the bill.Example:
0119532152
Query Parameters
-
premiseId: string
Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.Example:
3836403369
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1BlAccCtxt
Type:
Show Source
object
-
account: object
account
-
accountInformation: object
accountInformation
-
accountPersons: object
accountPersons
-
customerClass: object
customerClass
-
division: object
division
-
premiseCount: number
Minimum Value:
0
Maximum Value:99999
The count of premises defined for an accountExample:2
-
premiseInformation: object
premiseInformation
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID identifies the customer who is responsible for the bill.Example:0119532152
Nested Schema : accountInformation
Type:
Show Source
object
-
accountName: string
Maximum Length:
254
Name -
info: string
Maximum Length:
254
Account Info displays information associated with an Account.Example:Brazil,Mark, Residential, $19,247.81
-
primaryText: string
Maximum Length:
1000
Primary text for Person Information -
secondaryText: string
Maximum Length:
1000
Secondary text for Person Information -
tertiaryText: string
Maximum Length:
1000
Tertiary text for Person Information
Nested Schema : customerClass
Type:
Show Source
object
-
customerClass: string
Maximum Length:
8
Customer Class controls financial parameters related to billing and collections and is required on an account.Example:R
-
description: string
Maximum Length:
60
Description for Customer classExample:Residential
Nested Schema : division
Type:
Show Source
object
-
description: string
Maximum Length:
60
Description for Customer classExample:Residential
-
division: string
Maximum Length:
5
CIS Division
Nested Schema : premiseInformation
Type:
Show Source
object
-
info: string
Maximum Length:
254
Premise InformationExample:129 Sutter St, San Francisco, CA, 94104
-
premiseId: string
Maximum Length:
10
Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.Example:3836403369
-
primaryText: string
Maximum Length:
1000
Primary text for Person Information -
secondaryText: string
Maximum Length:
1000
Secondary text for Person Information -
tertiaryText: string
Maximum Length:
1000
Tertiary text for Person Information
Nested Schema : items
Type:
Show Source
object
-
accountRelationshipType: object
accountRelationshipType
-
isFinanciallyResponsible: boolean
Financially Responsible switch is on if the person is financially responsible for the account's debt.Example:
true
-
isMainCustomer: boolean
Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.Example:
false
-
person: object
person
-
personInformation: object
personInformation
-
primaryName: string
Maximum Length:
254
Name -
receivesCopyOfBill: boolean
Receives Copy of Bill is defined as true if the person receives a copy of the account's bills.Example:
true
Nested Schema : accountRelationshipType
Type:
Show Source
object
-
accountRelationshipType: string
Maximum Length:
8
Account Relationship Type -
description: string
Maximum Length:
60
Description for Customer classExample:Residential
Nested Schema : person
Type:
Show Source
object
-
personId: string
Maximum Length:
10
Person ID is the system-assigned number for other persons related to the account.
Nested Schema : personInformation
Type:
Show Source
object
-
info: string
Maximum Length:
254
Person Info -
personOrBusiness: string
Allowed Values:
[ "B ", "P " ]
Defines the person entity as a person or business, which controls validation of the person entity's primary name. * `B ` - Business, * `P ` - PersonExample:P
-
primaryText: string
Maximum Length:
1000
Primary text for Person Information -
secondaryText: string
Maximum Length:
1000
Secondary text for Person Information -
tertiaryText: string
Maximum Length:
1000
Tertiary text for Person Information
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.