Update Account
put
https://server:port/spl/rest/apis/customer/v-model/accounts/{accountId}
This operation handles the Integration Suite API to Update Account
Request
Path Parameters
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
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:
10
The Account ID is a system-assigned random number that stays with an account for life.Example:1589809032
-
accountManagementGroup: object
accountManagementGroup
The Account Management Group controls the roles assigned to To Do entries associated with an account.
-
accountPersons: object
accountPersons
-
alertInformation: string
Maximum Length:
4000
Alerts highlight important information to 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
Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.
-
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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : accessGroup
Type:
object
Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.
Show Source
-
accessGroup: string
Maximum Length:
12
Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.Example:***
Nested Schema : accountManagementGroup
Type:
object
The Account Management Group controls the roles assigned to To Do entries associated with an account.
Show Source
-
accountManagementGroup: string
Maximum Length:
10
The Account Management Group controls the roles assigned to To Do entries associated with an account.Example:LANDLORD
Nested Schema : billCycle
Type:
object
Bill Cycle Code controls the schedule of when a bill should be generated for an account.
Show Source
-
billCycle: string
Maximum Length:
4
Bill Cycle Code controls the schedule of when a bill should be generated for an account.Example:MO17
Nested Schema : billPrintIntercept
Type:
object
Provide a user's ID to require review of the account's printed bills before they are sent to the customer.
Show Source
-
billPrintIntercept: string
Maximum Length:
8
Provide 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:
object
Budget Plan controls how the account's debt is managed for budget-related purposes.
Show Source
-
budgetPlan: string
Maximum Length:
8
Budget Plan controls how the account's debt is managed for budget-related purposes.Example:RES BUD
Nested Schema : collectionClass
Type:
object
Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.
Show Source
-
collectionClass: string
Maximum Length:
10
Collection 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:
object
Account Credit Rating History collection contains one entry for each credit rating history record associated with the account.
Show Source
Nested Schema : currency
Type:
object
Currency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
currency: string
Maximum Length:
3
Currency Code defines the currency in which the account's financial transactions are expressed.Example:USD
Nested Schema : customerClass
Type:
object
Customer Class controls financial parameters related to billing and collections.
Show Source
-
customerClass: string
Maximum Length:
8
Customer Class controls financial parameters related to billing and collections.Example:R
Nested Schema : division
Type:
object
CIS Division defines the jurisdiction that governs this account.
Show Source
-
division: string
Maximum Length:
5
CIS Division defines the jurisdiction that governs this account.Example:CA
Nested Schema : mailingPremise
Type:
object
Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.
Show Source
-
mailingPremiseId: string
Maximum Length:
10
Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.
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.Example: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:
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
-
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:
50
Additional 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 defined as true 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 is defined as true 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 is allowed web access for customer self-service. * `ALWD` - Allowed, * `NALW` - Not allowedExample:NALW
Nested Schema : accountRelationshipType
Type:
Show Source
object
-
accountRelationshipType: string
Maximum Length:
8
Account Relationship Type
Nested Schema : billRouteType
Type:
Show Source
object
-
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.
Nested Schema : quoteRouteType
Type:
Show Source
object
-
quoteRouteType: string
Maximum Length:
12
Quote Route Type
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
-
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 is defined as true if the address is considered within the physical city limits.
-
postal: string
Maximum Length:
12
The postal code of the address. -
state: object
state
-
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 : 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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
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.
-
autoPayMethod: object
autoPayMethod
-
autoPaySource: object
autoPaySource
-
comments: string
Maximum Length:
254
Comments can describe anything interesting or 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:
254
Name 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:
50
Use 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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : accountAutoPay
Type:
Show Source
object
-
accountAutoPayId: string
Maximum Length:
10
Auto Pay ID
Nested Schema : autoPayMethod
Type:
Show Source
object
-
autoPayMethod: string
Allowed Values:
[ "C1DD", "C1PA" ]
Auto Pay Method defines whether the system should process automatic payments as Direct Debit or Payment Advice.
Nested Schema : autoPaySource
Type:
Show Source
object
-
autoPaySource: string
Maximum Length:
12
Auto Pay Source is used to define the source of the funds, such as a banking institution, used to satisfy the automatic payment request.
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
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
affectCreditRatingBy: number
Minimum Value:
-99999
Maximum Value:99999
Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.Example:100
-
cashOnlyPoints: number
Minimum Value:
-99999
Maximum Value:99999
Affect 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:
254
Comments can describe anything interesting or unusual about the automatic payment request. -
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:
10
The 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:
-999
Maximum Value:999
A 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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
-
writeOffProcess: object
writeOffProcess
Nested Schema : collectionProcess
Type:
Show Source
object
-
collectionProcessId: string
Maximum Length:
10
Collection Process ID is the unique system-generated identifier for this collection process.Example:1589809419
Nested Schema : severanceProcessId
Type:
Show Source
object
-
severanceProcessId: string
Maximum Length:
10
Severance Process ID is the unique system-generated identifier for this severance process.Example:1589809419
Nested Schema : user
Type:
Show Source
object
-
userId: string
Maximum Length:
8
User that created the record.Example:CDX
Nested Schema : writeOffProcess
Type:
Show Source
object
-
writeOffProcessId: string
Maximum Length:
10
Write Off Process ID
Nested Schema : items
Type:
Show Source
object
-
billMessage: object
billMessage
-
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
-
messageParameters: object
messageParameters
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : billMessage
Type:
Show Source
object
-
billMessage: string
Maximum Length:
4
Bill Message is a message that appears on the customer's bill.
Nested Schema : items
Type:
Show Source
object
-
messageParameterValue: string
Maximum Length:
2000
Message Parameter Value -
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
version: number
Minimum Value:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : items
Type:
Show Source
object
-
comments: string
Maximum Length:
254
Comments can describe anything interesting or unusual about the automatic payment request. -
depositAmount: string
Maximum Length:
15
Amount of the non-cash deposit. -
depositClass: object
depositClass
-
documentNumber: string
Maximum Length:
20
Document 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:
-99999
Maximum Value:99999
A 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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : depositClass
Type:
Show Source
object
-
depositClass: string
Maximum Length:
8
Deposit Class
Nested Schema : nonCashDepositType
Type:
Show Source
object
-
nonCashDepositType: string
Maximum Length:
8
Non-Cash Deposit Type
Nested Schema : thirdPartySa
Type:
Show Source
object
-
thirdPartySaId: string
Maximum Length:
10
Deposit SA ID associated if a third-party has paid the cash deposit for the account.Example:1589809502
Root Schema : schema
Type:
Show Source
object
-
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:
10
The Account ID is a system-assigned random number that stays with an account for life.Example:1589809032
-
accountManagementGroup: object
accountManagementGroup
The Account Management Group controls the roles assigned to To Do entries associated with an account.
-
accountPersons: object
accountPersons
-
alertInformation: string
Maximum Length:
4000
Alerts highlight important information to 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
Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.
-
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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : accessGroup
Type:
object
Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.
Show Source
-
accessGroup: string
Maximum Length:
12
Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.Example:***
Nested Schema : accountManagementGroup
Type:
object
The Account Management Group controls the roles assigned to To Do entries associated with an account.
Show Source
-
accountManagementGroup: string
Maximum Length:
10
The Account Management Group controls the roles assigned to To Do entries associated with an account.Example:LANDLORD
Nested Schema : billCycle
Type:
object
Bill Cycle Code controls the schedule of when a bill should be generated for an account.
Show Source
-
billCycle: string
Maximum Length:
4
Bill Cycle Code controls the schedule of when a bill should be generated for an account.Example:MO17
Nested Schema : billPrintIntercept
Type:
object
Provide a user's ID to require review of the account's printed bills before they are sent to the customer.
Show Source
-
billPrintIntercept: string
Maximum Length:
8
Provide 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:
object
Budget Plan controls how the account's debt is managed for budget-related purposes.
Show Source
-
budgetPlan: string
Maximum Length:
8
Budget Plan controls how the account's debt is managed for budget-related purposes.Example:RES BUD
Nested Schema : collectionClass
Type:
object
Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.
Show Source
-
collectionClass: string
Maximum Length:
10
Collection 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:
object
Account Credit Rating History collection contains one entry for each credit rating history record associated with the account.
Show Source
Nested Schema : currency
Type:
object
Currency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
currency: string
Maximum Length:
3
Currency Code defines the currency in which the account's financial transactions are expressed.Example:USD
Nested Schema : customerClass
Type:
object
Customer Class controls financial parameters related to billing and collections.
Show Source
-
customerClass: string
Maximum Length:
8
Customer Class controls financial parameters related to billing and collections.Example:R
Nested Schema : division
Type:
object
CIS Division defines the jurisdiction that governs this account.
Show Source
-
division: string
Maximum Length:
5
CIS Division defines the jurisdiction that governs this account.Example:CA
Nested Schema : mailingPremise
Type:
object
Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.
Show Source
-
mailingPremiseId: string
Maximum Length:
10
Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.
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.Example: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:
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
-
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:
50
Additional 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 defined as true 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 is defined as true 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 is allowed web access for customer self-service. * `ALWD` - Allowed, * `NALW` - Not allowedExample:NALW
Nested Schema : accountRelationshipType
Type:
Show Source
object
-
accountRelationshipType: string
Maximum Length:
8
Account Relationship Type
Nested Schema : billRouteType
Type:
Show Source
object
-
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.
Nested Schema : quoteRouteType
Type:
Show Source
object
-
quoteRouteType: string
Maximum Length:
12
Quote Route Type
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
-
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 is defined as true if the address is considered within the physical city limits.
-
postal: string
Maximum Length:
12
The postal code of the address. -
state: object
state
-
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 : 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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
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.
-
autoPayMethod: object
autoPayMethod
-
autoPaySource: object
autoPaySource
-
comments: string
Maximum Length:
254
Comments can describe anything interesting or 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:
254
Name 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:
50
Use 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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : accountAutoPay
Type:
Show Source
object
-
accountAutoPayId: string
Maximum Length:
10
Auto Pay ID
Nested Schema : autoPayMethod
Type:
Show Source
object
-
autoPayMethod: string
Allowed Values:
[ "C1DD", "C1PA" ]
Auto Pay Method defines whether the system should process automatic payments as Direct Debit or Payment Advice.
Nested Schema : autoPaySource
Type:
Show Source
object
-
autoPaySource: string
Maximum Length:
12
Auto Pay Source is used to define the source of the funds, such as a banking institution, used to satisfy the automatic payment request.
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
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
affectCreditRatingBy: number
Minimum Value:
-99999
Maximum Value:99999
Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.Example:100
-
cashOnlyPoints: number
Minimum Value:
-99999
Maximum Value:99999
Affect 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:
254
Comments can describe anything interesting or unusual about the automatic payment request. -
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:
10
The 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:
-999
Maximum Value:999
A 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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
-
writeOffProcess: object
writeOffProcess
Nested Schema : collectionProcess
Type:
Show Source
object
-
collectionProcessId: string
Maximum Length:
10
Collection Process ID is the unique system-generated identifier for this collection process.Example:1589809419
Nested Schema : severanceProcessId
Type:
Show Source
object
-
severanceProcessId: string
Maximum Length:
10
Severance Process ID is the unique system-generated identifier for this severance process.Example:1589809419
Nested Schema : user
Type:
Show Source
object
-
userId: string
Maximum Length:
8
User that created the record.Example:CDX
Nested Schema : writeOffProcess
Type:
Show Source
object
-
writeOffProcessId: string
Maximum Length:
10
Write Off Process ID
Nested Schema : items
Type:
Show Source
object
-
billMessage: object
billMessage
-
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
-
messageParameters: object
messageParameters
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : billMessage
Type:
Show Source
object
-
billMessage: string
Maximum Length:
4
Bill Message is a message that appears on the customer's bill.
Nested Schema : items
Type:
Show Source
object
-
messageParameterValue: string
Maximum Length:
2000
Message Parameter Value -
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence -
version: number
Minimum Value:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : items
Type:
Show Source
object
-
comments: string
Maximum Length:
254
Comments can describe anything interesting or unusual about the automatic payment request. -
depositAmount: string
Maximum Length:
15
Amount of the non-cash deposit. -
depositClass: object
depositClass
-
documentNumber: string
Maximum Length:
20
Document 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:
-99999
Maximum Value:99999
A 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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : depositClass
Type:
Show Source
object
-
depositClass: string
Maximum Length:
8
Deposit Class
Nested Schema : nonCashDepositType
Type:
Show Source
object
-
nonCashDepositType: string
Maximum Length:
8
Non-Cash Deposit Type
Nested Schema : thirdPartySa
Type:
Show Source
object
-
thirdPartySaId: string
Maximum Length:
10
Deposit SA ID associated if a third-party has paid the cash deposit for the account.Example:1589809502
Response
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:
10
The Account ID is a system-assigned random number that stays with an account for life.Example:1589809032
-
accountManagementGroup: object
accountManagementGroup
The Account Management Group controls the roles assigned to To Do entries associated with an account.
-
accountPersons: object
accountPersons
-
alertInformation: string
Maximum Length:
4000
Alerts highlight important information to 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
Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.
-
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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : accessGroup
Type:
object
Access 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:
12
Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.Example:***
Nested Schema : accountManagementGroup
Type:
object
The Account Management Group controls the roles assigned to To Do entries associated with an account.
Show Source
-
_link: string
_link
-
accountManagementGroup: string
Maximum Length:
10
The Account Management Group controls the roles assigned to To Do entries associated with an account.Example:LANDLORD
Nested Schema : billCycle
Type:
object
Bill Cycle Code controls the schedule of when a bill should be generated for an account.
Show Source
-
_link: string
_link
-
billCycle: string
Maximum Length:
4
Bill Cycle Code controls the schedule of when a bill should be generated for an account.Example:MO17
Nested Schema : billPrintIntercept
Type:
object
Provide 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:
8
Provide 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:
object
Budget Plan controls how the account's debt is managed for budget-related purposes.
Show Source
-
_link: string
_link
-
budgetPlan: string
Maximum Length:
8
Budget Plan controls how the account's debt is managed for budget-related purposes.Example:RES BUD
Nested Schema : collectionClass
Type:
object
Collection 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:
10
Collection 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:
object
Account Credit Rating History collection contains one entry for each credit rating history record associated with the account.
Show Source
Nested Schema : currency
Type:
object
Currency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code defines the currency in which the account's financial transactions are expressed.Example:USD
Nested Schema : customerClass
Type:
object
Customer Class controls financial parameters related to billing and collections.
Show Source
-
_link: string
_link
-
customerClass: string
Maximum Length:
8
Customer Class controls financial parameters related to billing and collections.Example:R
Nested Schema : division
Type:
object
CIS Division defines the jurisdiction that governs this account.
Show Source
-
_link: string
_link
-
division: string
Maximum Length:
5
CIS Division defines the jurisdiction that governs this account.Example:CA
Nested Schema : mailingPremise
Type:
object
Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.
Show Source
-
_link: string
_link
-
mailingPremiseId: string
Maximum Length:
10
Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.
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.Example: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:
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
-
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:
50
Additional 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 defined as true 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 is defined as true 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 is 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:
8
Account Relationship Type
Nested Schema : billRouteType
Type:
Show Source
object
-
_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.
Nested Schema : personId
Type:
Show Source
object
-
_link: string
_link
-
personId: string
Maximum Length:
10
Person ID
Nested Schema : quoteRouteType
Type:
Show Source
object
-
_link: string
_link
-
quoteRouteType: string
Maximum Length:
12
Quote Route Type
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
-
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 is defined as true if the address is considered within the physical city limits.
-
postal: string
Maximum Length:
12
The postal code of the address. -
state: object
state
-
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:
Show Source
object
-
_link: string
_link
-
country: string
Maximum Length:
3
Country
Nested Schema : state
Type:
Show Source
object
-
_link: string
_link
-
state: string
Maximum Length:
6
State
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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : alertType
Type:
Show Source
object
-
_link: string
_link
-
alertType: string
Maximum Length:
10
Alert 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.
-
autoPayMethod: object
autoPayMethod
-
autoPaySource: object
autoPaySource
-
comments: string
Maximum Length:
254
Comments can describe anything interesting or 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:
254
Name 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:
50
Use 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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : accountAutoPay
Type:
Show Source
object
-
_link: string
_link
-
accountAutoPayId: string
Maximum Length:
10
Auto Pay ID
Nested Schema : autoPayMethod
Type:
Show Source
object
-
_link: string
_link
-
autoPayMethod: string
Allowed Values:
[ "C1DD", "C1PA" ]
Auto Pay Method defines whether the system should process automatic payments as Direct Debit or Payment Advice.
Nested Schema : autoPaySource
Type:
Show Source
object
-
_link: string
_link
-
autoPaySource: string
Maximum Length:
12
Auto Pay Source is used to define the source of the funds, such as a banking institution, used to satisfy the automatic payment request.
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
Maximum Length:
4
Type of Char Value -
version: number
Minimum Value:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : characteristicType
Type:
Show Source
object
-
_link: string
_link
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
affectCreditRatingBy: number
Minimum Value:
-99999
Maximum Value:99999
Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.Example:100
-
cashOnlyPoints: number
Minimum Value:
-99999
Maximum Value:99999
Affect 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:
254
Comments can describe anything interesting or unusual about the automatic payment request. -
createDate: string
(date)
Creation Date
-
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:
10
The 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:
-999
Maximum Value:999
A 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:
-99999
Maximum Value:99999
The 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:
10
Collection Process ID is the unique system-generated identifier for this collection process.Example:1589809419
Nested Schema : payPlanId
Type:
Show Source
object
-
_link: string
_link
-
payPlanId: string
Maximum Length:
10
Pay Plan ID
Nested Schema : severanceProcessId
Type:
Show Source
object
-
_link: string
_link
-
severanceProcessId: string
Maximum Length:
10
Severance Process ID is the unique system-generated identifier for this severance process.Example:1589809419
Nested Schema : user
Type:
Show Source
object
-
_link: string
_link
-
userId: string
Maximum Length:
8
User that created the record.Example:CDX
Nested Schema : writeOffProcess
Type:
Show Source
object
-
_link: string
_link
-
writeOffProcessId: string
Maximum Length:
10
Write Off Process ID
Nested Schema : items
Type:
Show Source
object
-
billMessage: object
billMessage
-
billMessageExpanded: string
Maximum Length:
254
Message 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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : billMessage
Type:
Show Source
object
-
_link: string
_link
-
billMessage: string
Maximum Length:
4
Bill Message is a message that appears on the customer's bill.
Nested Schema : items
Type:
Show Source
object
-
comments: string
Maximum Length:
254
Comments can describe anything interesting or unusual about the automatic payment request. -
depositAmount: string
Maximum Length:
15
Amount of the non-cash deposit. -
depositClass: object
depositClass
-
documentNumber: string
Maximum Length:
20
Document 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:
-99999
Maximum Value:99999
A 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:
-99999
Maximum Value:99999
The version number is used for internal concurrency checks.Example:2
Nested Schema : depositClass
Type:
Show Source
object
-
_link: string
_link
-
depositClass: string
Maximum Length:
8
Deposit Class
Nested Schema : nonCashDepositType
Type:
Show Source
object
-
_link: string
_link
-
nonCashDepositType: string
Maximum Length:
8
Non-Cash Deposit Type
Nested Schema : thirdPartySa
Type:
Show Source
object
-
_link: string
_link
-
thirdPartySaId: string
Maximum Length:
10
Deposit SA ID associated if a third-party has paid the cash deposit for the account.Example:1589809502
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.