Get Account Person
get
/rest/apis/customer/v-model/accounts/{accountId}/persons/{personId}
Request
Path Parameters
-
accountId(required): string
The Account ID is a system-assigned random number that stays with an account for life.Example:
1589809032
-
personId(required): string
Person ID is the unique identifier of the person linked to the account.Example:
6543638120
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : accountPersons
Type:
Show Source
object
-
accountRelationshipType: object
accountRelationshipType
Relationship Type defines the relationship between the person and the account.
-
billAddressSource: string
Allowed Values:
[ "ACOV", "PER ", "PREM" ]
Address Source indicates the mailing address source if bills are routed using the postal service. * `ACOV` - Account Override, * `PER ` - Person, * `PREM` - Mailing Premise on AccountExample:PREM
-
billFormat: string
Allowed Values:
[ "D ", "S " ]
Bill Format Indicates if the customer should receive a detailed or a summary bill. * `D ` - Detailed, * `S ` - SummaryExample:D
-
billRouteType: object
billRouteType
Bill Route Type indicates how the bill is sent to the customer. This field's default value is retrieved from the Installation record.
-
customerPOId: string
Maximum Length:
20
Customer PO ID indicates if the customer wants a purchase order number printed on their copy of the bill. -
isFinanciallyResponsible: boolean
Financially Responsible is defined as true if the person is financially responsible for the account's debt.Example:
true
-
isMainCustomer: boolean
Main Customer is defined as true if the person is the main customer on the account. Only one person on an account can be designated as the main customer.Example:
true
-
isThirdPartyGuarantor: boolean
Third Party Guarantor is defined as true if the person is a third-party guarantor of the account's debt.Example:
false
-
numberOfBillCopies: number
Minimum Value:
-99
Maximum Value:99
Number of Bill Copies Indicates how many copies of the bill the person receives.Example:1
-
person: object
person
-
personAddressOverride: array
personAddressOverride
-
prefixOrSuffix: string
Allowed Values:
[ "PX ", "SX " ]
The Prefix or Suffix flag indicates if the Prefix or Suffix Name is appended to the front or the back of the customer's name on correspondence. * `PX ` - Prefix to Name, * `SX ` - Suffix to NameExample:PX
-
prefixSuffixName: string
Maximum Length:
50
Additional information to append to a customer's name when correspondence or bills are sent to this person. -
quoteRouteType: object
quoteRouteType
Quote Route Type is the method used to transmit the quote to the customer. This information defaults from Account - Person Information.
-
receivesNotification: boolean
Allow Communication Preference switch is on if the person's contacts can be used on communication preferences for this account.Example:
true
-
shouldReceiveCopyOfBill: boolean
Receives Copy of Bill is defined as true if the person receives a copy of the account's bills.Example:
true
-
shouldReceiveCopyOfQuote: boolean
Receives Copy of Quote switch is on if the person receives a copy of the account's quotes.Example:
false
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
-
webAccess: string
Allowed Values:
[ "ALWD", "NALW" ]
Web Access indicates if the related person should be allowed web access for customer self-service. * `ALWD` - Allowed, * `NALW` - Not allowedExample:NALW
Nested Schema : accountRelationshipType
Type:
object
Relationship Type defines the relationship between the person and the account.
Show Source
-
_link: string
_link
-
accountRelationshipType: string
Maximum Length:
8
Relationship Type defines the relationship between the person and the account.Example:MAIN
Nested Schema : billRouteType
Type:
object
Bill Route Type indicates how the bill is sent to the customer. This field's default value is retrieved from the Installation record.
Show Source
-
_link: string
_link
-
billRouteType: string
Maximum Length:
8
Bill Route Type indicates how the bill is sent to the customer. This field's default value is retrieved from the Installation record.Example:POSTAL
Nested Schema : person
Type:
Show Source
object
-
_link: string
_link
-
personId: string
Maximum Length:
10
Person ID is the unique identifier of the person linked to the account.Example:6543638120
Nested Schema : quoteRouteType
Type:
object
Quote Route Type is the method used to transmit the quote to the customer. This information defaults from Account - Person Information.
Show Source
-
_link: string
_link
-
quoteRouteType: string
Maximum Length:
12
Quote Route Type is the method used to transmit the quote to the customer. This information defaults from Account - Person Information.
Nested Schema : items
Type:
Show Source
object
-
address1: string
Maximum Length:
254
The first line of the address. -
address2: string
Maximum Length:
254
The second line of the address. -
address3: string
Maximum Length:
254
The third line of the address. -
address4: string
Maximum Length:
254
The fourth line of the address. -
city: string
Maximum Length:
90
The city of the address. -
country: object
country
Country defaults from the installation options. The address constituents may differ depending on the Country.
-
county: string
Maximum Length:
90
The county of the address. -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
isInCityLimit: boolean
In City Limit switch is on if the address is considered within the physical city limits.
-
personId: string
Maximum Length:
10
Person ID is the unique identifier of the person linked to the account.Example:6543638120
-
postal: string
Maximum Length:
12
The postal code of the address. -
state: object
state
The state of the address.
-
streetNumber1: string
Maximum Length:
6
The first street number line of the address. -
streetNumber2: string
Maximum Length:
4
The second street number line of the address. -
taxVendorGeographicalCode: string
Maximum Length:
11
Geographic code used to apply proper taxation rules to the physical address location. -
version: number
Minimum Value:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : country
Type:
object
Country defaults from the installation options. The address constituents may differ depending on the Country.
Show Source
-
_link: string
_link
-
country: string
Maximum Length:
3
Country defaults from the installation options. The address constituents may differ depending on the Country.
Nested Schema : state
Type:
object
The state of the address.
Show Source
-
_link: string
_link
-
state: string
Maximum Length:
6
The state of the address.
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.