Get Account
get
/spl/rest/apis/customer/v-model/accounts/{accountId}
Request
Path Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1-CXAccount
Type:
Show Source
object-
_self: string
_self
-
accessGroup: object
accessGroup
Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.
-
accountId: string
Maximum Length:
10The Account ID is a system-assigned random number that stays with an account for life.Example:1589809032 -
accountPersons: object
accountPersons
-
alertInformation: string
Maximum Length:
4000Alerts bring important information to the attention of any customer service representative who looks at the account. -
alerts: object
alerts
-
autoPay: object
autoPay
-
billAfterDate: string
(date)
Bill After Date postpones billing until after a future date.Example:
2001-01-01 -
billCycle: object
billCycle
Bill Cycle Code controls the schedule of when a bill should be generated for an account.
-
billPrintIntercept: object
billPrintIntercept
Provide a user's ID to require review of the account's printed bills before they are sent to the customer.
-
budgetPlan: object
budgetPlan
Budget Plan controls how the account's debt is managed for budget-related purposes.
-
characteristics: object
characteristics
-
collectionClass: object
collectionClass
Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.
-
creditRatingHistory: object
creditRatingHistory
Account Credit Rating History collection contains one entry for each credit rating history record associated with the account.
-
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
customerClass: object
customerClass
Customer Class controls financial parameters related to billing and collections.
-
division: object
division
CIS Division defines the jurisdiction that governs this account.
-
doNotReviewDeposit: boolean
When defined as true, the account is not considered by the Deposit Review background process or by the Deposit Refund background process.Example:
true -
lastCreditReviewDate: string
(date)
Last Credit Review Date is the date when the account's debt was last reviewed by the account debt monitor (ADM) background process.Example:
2016-10-26 -
mailingPremise: object
mailingPremise
-
messages: object
messages
-
nonCashDeposits: object
nonCashDeposits
-
postponeCreditReviewUntilDate: string
(date)
Defining a future data prevents an account from being reviewed by credit and collections processes, such as the account debt monitor and the write-off monitor, until after the defined date.
-
setUpDate: string
(date)
Set Up Date is the date the account was initially created.Example:
2001-01-01 -
shouldProtectBillCycle: boolean
When defined as true, the system does not change the bill cycle when a service agreement is activated. By default, service agreement activation can modify the bill cycle.Example:
false -
shouldProtectDivision: boolean
When defined as true, assigned CIS divisions are not modified when a service agreement is activated. By default, service agreement activation can modify the CIS division.Example:
false -
shouldProtectMailingPremise: boolean
When defined as true, the mailing premise is not modified when a service agreement is activated. If defined as false, the mailing address can be updated when a service agreement is activated.Example:
true -
version: number
Minimum Value:
-99999Maximum Value:99999The version number is used for internal concurrency checks.Example:2
Nested Schema : accessGroup
Type:
objectAccess Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.
Show Source
-
_link: string
_link
-
accessGroup: string
Maximum Length:
12Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.Example:***
Nested Schema : billCycle
Type:
objectBill Cycle Code controls the schedule of when a bill should be generated for an account.
Show Source
-
_link: string
_link
-
billCycle: string
Maximum Length:
4Bill Cycle Code controls the schedule of when a bill should be generated for an account.Example:MO17
Nested Schema : billPrintIntercept
Type:
objectProvide a user's ID to require review of the account's printed bills before they are sent to the customer.
Show Source
-
_link: string
_link
-
billPrintIntercept: string
Maximum Length:
8Provide a user's ID to require review of the account's printed bills before they are sent to the customer.Example:MBRAZIL (Brazil, Mark)
Nested Schema : budgetPlan
Type:
objectBudget Plan controls how the account's debt is managed for budget-related purposes.
Show Source
-
_link: string
_link
-
budgetPlan: string
Maximum Length:
8Budget Plan controls how the account's debt is managed for budget-related purposes.Example:RES BUD
Nested Schema : collectionClass
Type:
objectCollection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.
Show Source
-
_link: string
_link
-
collectionClass: string
Maximum Length:
10Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.Example:RESID
Nested Schema : creditRatingHistory
Type:
objectAccount Credit Rating History collection contains one entry for each credit rating history record associated with the account.
Show Source
Nested Schema : currency
Type:
objectCurrency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
_link: string
_link
-
currency: string
Maximum Length:
3Currency Code defines the currency in which the account's financial transactions are expressed.Example:USD
Nested Schema : customerClass
Type:
objectCustomer Class controls financial parameters related to billing and collections.
Show Source
-
_link: string
_link
-
customerClass: string
Maximum Length:
8Customer Class controls financial parameters related to billing and collections.Example:R
Nested Schema : division
Type:
objectCIS Division defines the jurisdiction that governs this account.
Show Source
-
_link: string
_link
-
division: string
Maximum Length:
5CIS Division defines the jurisdiction that governs this account.Example:CA
Nested Schema : mailingPremise
Type:
Show Source
object-
_link: string
_link
-
mailingPremiseId: string
Maximum Length:
10Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field may be updated behind the scenes when a service agreement is activated.Example:3308038454
Nested Schema : items
Type:
Show Source
object-
accountRelationshipType: object
accountRelationshipType
-
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
-
customerPOId: string
Maximum Length:
20Customer 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:
-99Maximum Value:99Number of Bill Copies Indicates how many copies of the bill the person receives.Example:1 -
personAddressOverride: array
personAddressOverride
-
personId: object
personId
-
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:
50Additional information to append to a customer's name when correspondence or bills are sent to this person. -
quoteRouteType: object
quoteRouteType
-
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:
-99999Maximum Value:99999The 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:
Show Source
object-
_link: string
_link
-
accountRelationshipType: string
Maximum Length:
8Account Relationship Type
Nested Schema : billRouteType
Type:
Show Source
object-
_link: string
_link
-
billRouteType: string
Maximum Length:
8Bill Route Type
Nested Schema : personId
Type:
Show Source
object-
_link: string
_link
-
personId: string
Maximum Length:
10Person ID
Nested Schema : quoteRouteType
Type:
Show Source
object-
_link: string
_link
-
quoteRouteType: string
Maximum Length:
12Quote Route Type
Nested Schema : items
Type:
Show Source
object-
address1: string
Maximum Length:
254The first line of the address. -
address2: string
Maximum Length:
254The second line of the address. -
address3: string
Maximum Length:
254The third line of the address. -
address4: string
Maximum Length:
254The fourth line of the address. -
city: string
Maximum Length:
90The city of the address. -
country: object
country
-
county: string
Maximum Length:
90The 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:
10Person ID is the unique identifier of the person linked to the account.Example:6543638120 -
postal: string
Maximum Length:
12The postal code of the address. -
state: object
state
-
streetNumber1: string
Maximum Length:
6The first street number line of the address. -
streetNumber2: string
Maximum Length:
4The second street number line of the address. -
taxVendorGeographicalCode: string
Maximum Length:
11Geographic code used to apply proper taxation rules to the physical address location. -
version: number
Minimum Value:
-99999Maximum Value:99999The version number is used for internal concurrency checks.Example:2
Nested Schema : country
Type:
Show Source
object-
_link: string
_link
-
country: string
Maximum Length:
3Country
Nested Schema : state
Type:
Show Source
object-
_link: string
_link
-
state: string
Maximum Length:
6State
Nested Schema : items
Type:
Show Source
object-
alertType: object
alertType
-
endDate: string
(date)
End Date indicates the date on which the alert stops showing for the account.Example:
2001-01-01 -
startDate: string
(date)
Start Date indicates the date on which the alert starts showing for the account.Example:
2001-01-01 -
version: number
Minimum Value:
-99999Maximum Value:99999The version number is used for internal concurrency checks.Example:2
Nested Schema : alertType
Type:
Show Source
object-
_link: string
_link
-
alertType: string
Maximum Length:
10Alert Type
Nested Schema : items
Type:
Show Source
object-
accountAutoPay: object
accountAutoPay
-
autoPayMaxWithdrawalAmount: number
Maximum Withdrawal Amount limits the amount of money that is automatically debited from an account.Example:
$50.00 -
autoPayMethod: object
autoPayMethod
-
autoPaySource: object
autoPaySource
-
comments: string
Maximum Length:
254Comments can describe anything interesting / unusual about the automatic payment request. -
endDate: string
(date)
End Date indicates the date on which the alert stops showing for the account.Example:
2001-01-01 -
entityName: string
Maximum Length:
254Name of the customer as it appears in the financial institution's system.Example:Brazil, Mark -
expireDate: string
(date)
Expires On date is used if the Auto Pay Source Code references a tender type that requires an expiration date.Example:
2001-01-01 -
externalAccountId: string
Maximum Length:
50Use External Account ID to define the customer's bank account or credit card number.Example:******789 -
startDate: string
(date)
Start Date indicates the date on which the alert starts showing for the account.Example:
2001-01-01 -
version: number
Minimum Value:
-99999Maximum Value:99999The version number is used for internal concurrency checks.Example:2
Nested Schema : accountAutoPay
Type:
Show Source
object-
_link: string
_link
-
accountAutoPayId: string
Maximum Length:
10Auto Pay ID
Nested Schema : autoPayMethod
Type:
Show Source
object-
_link: string
_link
-
autoPayMethod: string
Allowed Values:
[ "C1DD", "C1PA" ]Auto Pay Method: * `C1DD` - Credit Card / Direct Debit, * `C1PA` - Payment Advice
Nested Schema : autoPaySource
Type:
Show Source
object-
_link: string
_link
-
autoPaySource: string
Maximum Length:
12Auto Pay Source
Nested Schema : items
Type:
Show Source
object-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
effectiveDate: string
(date)
Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.Example:
2001-01-01 -
typeOfCharacteristicValue: string
Allowed Values:
[ "ADV ", "DFV ", "FKV ", "FLV " ]Type of Char Value: * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value -
version: number
Minimum Value:
-99999Maximum Value:99999The version number is used for internal concurrency checks.Example:2
Nested Schema : characteristicType
Type:
Show Source
object-
_link: string
_link
-
characteristicType: string
Maximum Length:
8Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object-
_link: string
(_link)
-
value: string
Maximum Length:
254Adhoc Characteristic Value -
value2: string
Maximum Length:
50Foreign Key Value 2 -
value3: string
Maximum Length:
50Foreign Key Value 3 -
value4: string
Maximum Length:
50Foreign Key Value 4 -
value5: string
Maximum Length:
50Foreign Key Value 5
Nested Schema : items
Type:
Show Source
object-
affectCreditRatingBy: number
Minimum Value:
-99999Maximum Value:99999Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.Example:100 -
cashOnlyPoints: number
Minimum Value:
-99999Maximum Value:99999Affect Cash-Only Score By is the effect of the credit rating transaction on the account's cash-only score.Example:100 -
collectionProcess: object
collectionProcess
-
comments: string
Maximum Length:
254Comments can describe anything interesting / unusual about the automatic payment request. -
createDate: string
(date)
Creation Date is the date of creation of credit rating transaction.Example:
2005-05-13 -
creditRatingCreatedBy: string
Allowed Values:
[ "COLL", "CUTP", "MN ", "NSF ", "ODP ", "OT ", "PP ", "SEV ", "WO " ]The credit rating transaction includes a Created By flag that is customizable using the Lookup table. * `COLL` - Collection Process, * `CUTP` - Cut Process, * `MN ` - Manual, * `NSF ` - NSF Assessment, * `ODP ` - Overdue Process, * `OT ` - Other, * `PP ` - Pay Plan, * `SEV ` - Severance Process, * `WO ` - Write OffExample:PP -
creditRatingHistoryId: string
Maximum Length:
10The Credit Rating History contains one entry for each credit rating history record associated with the account.Example:1589809596 -
endDate: string
(date)
End Date indicates the date on which the alert stops showing for the account.Example:
2001-01-01 -
eventSequence: number
Minimum Value:
-999Maximum Value:999A sequence is used to define the order of the credit rating event records.Example:0 -
payPlanId: object
payPlanId
-
severanceProcessId: object
severanceProcessId
-
startDate: string
(date)
Start Date indicates the date on which the alert starts showing for the account.Example:
2001-01-01 -
user: object
user
-
version: number
Minimum Value:
-99999Maximum Value:99999The version number is used for internal concurrency checks.Example:2 -
writeOffProcess: object
writeOffProcess
Nested Schema : collectionProcess
Type:
Show Source
object-
_link: string
_link
-
collectionProcessId: string
Maximum Length:
10Collection Process ID
Nested Schema : payPlanId
Type:
Show Source
object-
_link: string
_link
-
payPlanId: string
Maximum Length:
10Pay Plan ID
Nested Schema : severanceProcessId
Type:
Show Source
object-
_link: string
_link
-
severanceProcessId: string
Maximum Length:
10Severance Process ID
Nested Schema : user
Type:
Show Source
object-
_link: string
_link
-
userId: string
Maximum Length:
8User
Nested Schema : writeOffProcess
Type:
Show Source
object-
_link: string
_link
-
writeOffProcessId: string
Maximum Length:
10Write Off Process ID
Nested Schema : items
Type:
Show Source
object-
billMessage: object
billMessage
-
billMessageExpanded: string
Maximum Length:
254Message on Bill -
billMessageType: string
Allowed Values:
[ "P ", "T " ]Bill Message Type indicates if the message should remain permanent or temporarily only be linked to the next bill produced for the account. * `P ` - Permanent, * `T ` - TemporaryExample:T -
version: number
Minimum Value:
-99999Maximum Value:99999The version number is used for internal concurrency checks.Example:2
Nested Schema : billMessage
Type:
Show Source
object-
_link: string
_link
-
billMessage: string
Maximum Length:
4Bill Message
Nested Schema : items
Type:
Show Source
object-
comments: string
Maximum Length:
254Comments can describe anything interesting / unusual about the automatic payment request. -
depositAmount: number
Deposit Amount
-
depositClass: object
depositClass
-
documentNumber: string
Maximum Length:
20Document Number associated with the non-cash deposit. For example, the letter of credit number, the surety bond number, and so on. -
endDate: string
(date)
End Date indicates the date on which the alert stops showing for the account.Example:
2001-01-01 -
nonCashDepositType: object
nonCashDepositType
-
sequence: number
Minimum Value:
-99999Maximum Value:99999A sequence is used to define the order of the records. -
startDate: string
(date)
Start Date indicates the date on which the alert starts showing for the account.Example:
2001-01-01 -
thirdPartySa: object
thirdPartySa
-
version: number
Minimum Value:
-99999Maximum Value:99999The version number is used for internal concurrency checks.Example:2
Nested Schema : depositClass
Type:
Show Source
object-
_link: string
_link
-
depositClass: string
Maximum Length:
8Deposit Class
Nested Schema : nonCashDepositType
Type:
Show Source
object-
_link: string
_link
-
nonCashDepositType: string
Maximum Length:
8Non-Cash Deposit Type
Nested Schema : thirdPartySa
Type:
Show Source
object-
_link: string
_link
-
thirdPartySaId: string
Maximum Length:
10Service Agreement
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully 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:
60URL 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:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully 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:
60URL 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:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.