Search Person Accounts
post
/rest/apis/customer/v-model/billingContext/searchPersonAccounts
This operation lists accounts associated with a specific person record. It supports various filter options, pagination and an optional textual search across the account's identifier, the account's name if any, and premise address.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
filters: object
filters
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
LimitExample:25
-
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
OffsetExample:0
-
personId: string
Maximum Length:
10
Person ID is the system-assigned number for other persons related to the account. -
queryOption: string
Allowed Values:
[ "C1BS", "C1LS", "C1US" ]
The service may be used to implement a basic list of accounts with minimal filtering options or a more advanced query that supports a textual search and includes either billing or usage details. * `C1BS` - Billing Search, * `C1LS` - List, * `C1US` - Usage Search -
serviceType: string
Maximum Length:
80
Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.Example:G
Nested Schema : filters
Type:
Show Source
object
-
active: string
Allowed Values:
[ "I ", "N ", "Y " ]
Active flag is used to return the list of active, inactive and all (including both active and inactive) accounts. * `I ` - Inactive, * `N ` - All, * `Y ` - YesExample:Y
-
endDate: string
(date)
Billing End DateExample:
2021-09-01
-
mainCustomer: string
Allowed Values:
[ "N ", "Y " ]
Main Customer flag is used to restrict the list to accounts where the person in context is the main customer. * `N ` - No, * `Y ` - YesExample:Y
-
searchText: string
Maximum Length:
200
Search Text
Root Schema : schema
Type:
Show Source
object
-
filters: object
filters
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
LimitExample:25
-
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
OffsetExample:0
-
personId: string
Maximum Length:
10
Person ID is the system-assigned number for other persons related to the account. -
queryOption: string
Allowed Values:
[ "C1BS", "C1LS", "C1US" ]
The service may be used to implement a basic list of accounts with minimal filtering options or a more advanced query that supports a textual search and includes either billing or usage details. * `C1BS` - Billing Search, * `C1LS` - List, * `C1US` - Usage Search -
serviceType: string
Maximum Length:
80
Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.Example:G
Nested Schema : filters
Type:
Show Source
object
-
active: string
Allowed Values:
[ "I ", "N ", "Y " ]
Active flag is used to return the list of active, inactive and all (including both active and inactive) accounts. * `I ` - Inactive, * `N ` - All, * `Y ` - YesExample:Y
-
endDate: string
(date)
Billing End DateExample:
2021-09-01
-
mainCustomer: string
Allowed Values:
[ "N ", "Y " ]
Main Customer flag is used to restrict the list to accounts where the person in context is the main customer. * `N ` - No, * `Y ` - YesExample:Y
-
searchText: string
Maximum Length:
200
Search Text
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1ActForPers
Type:
Show Source
object
-
accounts: array
accounts
The list of accounts for the person in context.
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
LimitExample:25
-
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
OffsetExample:0
-
totalNumberOfRecords: number
Minimum Value:
0
Maximum Value:99999
Total Number Of RecordsExample:2
Nested Schema : items
Type:
Show Source
object
-
account: object
account
-
accountName: string
Maximum Length:
254
The name of the account.Note: This information is optional and assumed to be captured as a characteristic record for the account. The characteristic type used for this purpose needs to be defined as a schema constant.
-
accountPersonRelationshipType: string
Maximum Length:
8
Account Relationship Type -
accountPersonRelationshipTypeDescription: string
Maximum Length:
1
Display string for relationship the input person has with the Billing Account.Example:Main customer
-
billingDetails: object
billingDetails
Billing information for the account. These details are only supported in billing search query mode.
-
isActive: boolean
Indicates whether the account is active or not.Example:
true
-
mainCustomerName: string
Maximum Length:
254
Name -
premiseDetails: object
premiseDetails
The premise used for display purposes. When multiple premises are associated with the account, the mailing premise is used.
-
serviceDetails: object
serviceDetails
The types of services associated with the account.
-
setupDate: string
(date)
The date the billing account was created. (Service often begins on that date, but doesn't have to).
-
usageDetails: object
usageDetails
Billed usage information for the account. These details are only supported in usage search query mode.
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 : billingDetails
Type:
object
Billing information for the account. These details are only supported in billing search query mode.
Show Source
-
annualBilledAmount: number
Sum billed over time period (12 months if available)Example:
200
-
billingEndDate: string
(date)
Billing End DateExample:
2021-09-01
-
billingStartDate: string
(date)
Billing Start DateExample:
2021-09-01
-
currency: string
Maximum Length:
3
Currency Code defines the currency in which the account's financial transactions are expressed.Example:USD
-
currentBalance: number
The current amount owed by the customer on the billing account (calculated value)Example:
-252.2
-
totalBalance: number
The amount the customer would need to pay to fully close the account (taking into consideration any deposits, budget billing, loans, etc.)Example:
361.64
Nested Schema : premiseDetails
Type:
object
The premise used for display purposes. When multiple premises are associated with the account, the mailing premise is used.
Show Source
-
numberOfPremises: number
Minimum Value:
0
Maximum Value:99999
Number of Premises related to the billing accountExample:2
-
premiseAddress1: string
Maximum Length:
254
Address -
premiseFormattedAddress: 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
Nested Schema : serviceDetails
Type:
object
The types of services associated with the account.
Show Source
Nested Schema : usageDetails
Type:
object
Billed usage information for the account. These details are only supported in usage search query mode.
Show Source
-
firstBillDate: string
(date)
The start date of the earliest bill associated with the reported usage for the account in the past 12 months.
-
lastBillDate: string
(date)
The end date of the latest bill associated with the reported usage for the account in the past 12 months.
-
usageFound: boolean
The Usage found flag indicates that usage data was available in the requested timeframe.Example:
Y
-
usageInformation: array
usageInformation
Nested Schema : items
Type:
Show Source
object
-
isActive: boolean
Indicates whether the account is active or not.Example:
true
-
serviceType: string
Maximum Length:
80
Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.Example:G
Nested Schema : items
Type:
Show Source
object
-
peakIndicator: string
Maximum Length:
1
Measures Peak Quantity -
unitOfMeasure: string
Maximum Length:
30
Unit of Measure -
usage: array
usage
Nested Schema : items
Type:
Show Source
object
-
serviceQuantityIdentifer: string
Maximum Length:
30
SQI -
timeOfUse: string
Maximum Length:
30
Time of Use -
usageIdentifier: string
Maximum Length:
100
An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'. -
usageValue: number
Minimum Value:
0
Maximum Value:9999.999999
Usage
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.