...
Field Descriptions :
Characteristic: describes the characteristics of the individual or the organization such as individual hobbies, center of interests.
Field | Description |
name | Name of the characteristic |
value | Value of the characteristic |
ContactMedium: indicates the contact medium that could be used to contact the customer.
Field | Description |
preferred | If true, indicates that is the preferred contact medium |
type | Email address, telephone number, postal address |
validFor | The time period that the contact medium is valid for |
Customer: A person or organization that buys products and services from the enterprise or receives free offers or services. This is modeled as a Party playing the role of Customer. A Customer is a type of PartyRole.
Field | Description |
customerRank | Relative importance of this customer compared to other customers |
description | Detailed description of the customer |
href | Unique reference of the customer |
id | Unique identifier of the customer |
name | Displayable name |
status | Used to track the lifecycle status, e.g. existing, prospective or former customers |
validFor | To manage startDate and endDate of customer states |
CustomerAccount: Is used to represent an account for the customer to manage the billing aspects.
Field | Description |
description | Detailed description of the customer account |
href | Unique reference of the customer account |
id | Unique identifier of the customer account |
name | Name of the customer account |
status | The condition of the account, such as due, paid, in arrears, in collection |
CustomerCreditProfile: Credit profile for the customer (containing credit scoring, …). By default only the current credit profile is retrieved. It can be used as a list to give the customer credit profiles history, the first one in the list will be the current one.
Field | Description |
creditProfileDate | The date the profile was established. |
creditRiskRating | This is an integer whose value is used to rate the risk |
creditScore | A measure of a person's or organization's creditworthiness calculated on the basis of a combination of factors such as their income and credit history. |
validFor | The period for which the profile is valid. |
Medium: describes the contact medium that could be used to contact the customer
Field | Description |
city | City |
country | Country |
emailAddress | Full email address in standard format |
type | Type of medium (fax, mobile phone…) |
number | Phone number |
postcode | Postcode |
stateOrProvice | State or province |
street1 | Describes the street |
street2 | Complementary street description |
PaymentMean: defines a specific mean of payment (e.g. direct debit with all details associated).
Field | Description |
id | Unique identifier of the payment mean |
href | Reference of the payment mean |
name | Name of the payment mean |
RelatedParty: Defines party or partyRole linked to a specific entity.
Field | Description |
id | Unique identifier of related party |
href | Reference of the relatedParty, could be a party reference or a partyRole reference |
role | Role of the related party |
name | Name of the related party |
validFor | The period for which the related party is valid |
...
Field Descriptions :
Contact: An individual or an organization used as a contact point for a CustomerAccount and accessed via some contact medium.
Field | Description |
contactType | Type of contact: Primary, secondary… |
validFor | Validity period of that contact |
contactName | A displayable name for the contact |
partyRoleType | Identifies what kind of partyRole type is linked to the contact (for instance customer account manager) |
ContactMedium: indicates the contact medium that could be used to contact the customer.
Field | Description |
preferred | If true, indicates that is the preferred contact medium |
type | Email address, telephone number, postal address |
validFor | The time period that the contact medium is valid for |
Customer: A person or organization that buys products and services from the enterprise or receives free offers or services. This is modeled as a Party playing the role of Customer. A Customer is a type of PartyRole.
Field | Description |
customerRank | Relative importance of this customer compared to other customers |
description | Detailed description of the customer |
href | Unique reference of the customer |
id | Unique identifier of the customer |
name | Displayable name |
status | Used to track the lifecycle status, e.g. existing, prospective or former customers |
validFor | To manage startDate and endDate of customer states |
CustomerAccount: Is used to represent an account for the customer to manage the billing aspects.
Field | Description |
accountType | A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. |
creditLimit | The maximum amount of money that may be charged on an account. |
description | Detailed description of the customer account |
href | Unique reference of the customer account |
id | Unique identifier of the customer account |
lastModified | Date of last modification of customer account |
name | Name of the customer account |
pin | A multidigit personal identification number that is used |
receivableBalance | Overall receivable balance for the customer account |
status | The condition of the account, such as due, paid, in arrears, in collection |
CustomerAccountRelationship: Significant connection between customer accounts
Field | Description |
relationshipType | Type of relationship |
validFor | Validity period of that relationship |
CustomerAccountTaxExemption: Proof of freedom from taxes imposed by a taxing jurisdiction.
Field | Description |
certificateNumber | Identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction |
issuingJuridiction | Name of the taxing jurisdiction for which taxes are exempt. |
reason | Reason of the tax exemption |
validFor | Period for which the exemption is valid |
Medium: describes the contact medium that could be used to contact the customer
Field | Description |
city | City |
country | Country |
emailAddress | Full email address in standard format |
type | Type of medium (fax, mobile phone…) |
number | Phone number |
postcode | Postcode |
stateOrProvice | State or province |
street1 | Describes the street |
street2 | Complementary street description |
PaymentMean: defines a specific mean of payment (e.g. direct debit with all details associated).
Field | Description |
id | Unique identifier of the payment mean |
href | Reference of the payment mean |
name | Name of the payment mean |
PaymentPlan: Defines a plan for payment (when a customer wants to spread his payments)
Field | Description |
amount | Amount paid. |
numberOfPayments | Number of payments used to spread the global payment. |
paymentFrequency | Monthly, Bimonthly, … |
priority | Priority of the payment plan |
status | Status of the payment plan (effective, ineffective). |
type | Type of payment plan |
validFor | Validity period of the payment plan. |
RelatedParty: Defines party or partyRole linked to a specific entity.
Field | Description |
id | Unique identifier of related party |
href | Reference of the relatedParty, could be a party reference or a partyRole reference |
role | Role of the related party |
name | Name of the related party |
validFor | The period for which the related party is valid |
CustomerAccountBalance: Balances linked to the customer account.
Field | Description |
amount | Balance amount |
status | Due, Paid, … |
type | Deposit balance, Disputed balance, Loyalty balance, Receivable balance |
validFor | Balance validity period |
...
Field Descriptions :
BankAccount: describes the information of a bank account.
Field | Description |
iban | Is an international format to describe a bank account |
bic | Identifier of the bank according to its international code |
domiciliation | Address of the bank agency which manages the bank account |
accountHolder |
|
CreditCard: describes the credit card information.
Field | Description |
creditCardHolder | Name of the credit card holder |
type | Credit card type (Mastercard, Visa,…) |
number | Card number |
expirationDate | Expiration date of the card |
PaymentMean: defines a specific mean of payment (e.g. direct debit with all details associated).
Field | Description |
id | Unique identifier for the payment mean |
href | Reference of the payment mean |
name | Name of the payment mean |
validFor | Payment mean validity period |
type | Type of the payment mean |
RelatedParty: Defines party or partyRole linked to a specific entity.
Field | Description |
id | Unique identifier of related party |
href | Reference of the relatedParty, could be a party reference or a partyRole reference |
role | Role of the related party |
name | Name of the related party |
validFor | The period for which the related party is valid |
...
{ |
© TM Forum 2015. All Rights Reserved.