| Anchor |
|---|
| _Toc404169821 |
|---|
| _Toc404169821 |
|---|
|
Managed Entity and Task Resource Models| Anchor |
|---|
| _Toc404169822 |
|---|
| _Toc404169822 |
|---|
|
Customer ResourceThe customer resource is the main entity to access to customer information.
This entity contains mainly financial information about the customer: touch point to customer account(s) and credit profiles.
Below is a representation of the Customer resource in JSON format.
...
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 |
UML Model:
| Anchor |
|---|
| _Toc404169823 |
|---|
| _Toc404169823 |
|---|
|
Customer Account ResourceThe customer account resource is used to represent an account for the customer to manage billing aspects.
Customer account can contain customer tax exemption, related accounts, contact information, customer relation, account balances and payment plans.
Below is a representation of the Customer Account resource in JSON format.
...
- Customer credit profile is not a resource anymore, embedded in customer.
- The customer tax exemption is not a resource anymore, embedded in customerAccount.
- Each Payment plan has to be linked to a payment method -> paymentMean
UML model:
| Anchor |
|---|
| _Toc404169824 |
|---|
| _Toc404169824 |
|---|
|
Payment Mean ResourceThe payment mean resource is used to define a specific mean of payment (e.g. direct debit with all associated details).
Below are representations of the PaymentMean resource in JSON format.
...
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 |
UML model:
| Anchor |
|---|
| _Toc404169825 |
|---|
| _Toc404169825 |
|---|
|
Notification Resource ModelsNine notification event types are defined:
...
Customer Notification UML:
| Anchor |
|---|
| _Toc404169826 |
|---|
| _Toc404169826 |
|---|
|
Customer Create Notification{
"eventType": "CustomerCreateNotification",
"eventTime": "2014-09-27T05:46:25.0Z",
"eventId": "1562231",
"event":
{
"customer":
{
"id": "c1234",
Following a whole representation of the Customer with all its attributes See Customer Resource.
}
}
} |
| Anchor |
|---|
| _Toc404169827 |
|---|
| _Toc404169827 |
|---|
|
Customer Delete Notification{
"eventType": "CustomerDeleteNotification",
"eventTime": "2014-09-27T05:46:25.0Z",
"eventId": "114445231",
"event":
{
"customer":
{
"id": "c1234",
Following a whole representation of the Customer with all its attributes See Customer Resource.
}
}
} |
| Anchor |
|---|
| _Toc404169828 |
|---|
| _Toc404169828 |
|---|
|
Customer Update Notification{
"eventType": "CustomerUpdateNotification",
"eventTime": "2014-09-27T05:46:25.0Z",
"eventId": "1144231",
"event":
{
"customer":
{
"id": "c1234",
Following a whole representation of the Customer with all its attributes See Customer Resource.
}
}
} |
Customer Account Notification UML:
| Anchor |
|---|
| _Toc404169829 |
|---|
| _Toc404169829 |
|---|
|
Customer Account Create Notification{
"eventType": "CustomerAccountCreateNotification",
"eventTime": "2014-09-27T05:46:25.0Z",
"eventId": "1134231",
"event":
{
"customerAccount":
{
"id": "ca1234",
Following a whole representation of the Customer Account with all its attributes See Customer Account Resource.
}
}
} |
| Anchor |
|---|
| _Toc404169830 |
|---|
| _Toc404169830 |
|---|
|
Customer Account Delete Notification{
"eventType": "CustomerAccountDeleteNotification",
"eventTime": "2014-09-27T05:46:25.0Z",
"eventId": "1134231",
"event":
{
"customerAccount":
{
"id": "ca1234",
Following a whole representation of the Customer Account with all its attributes See Customer Account Resource.
}
}
} |
| Anchor |
|---|
| _Toc404169831 |
|---|
| _Toc404169831 |
|---|
|
Customer Account Update Notification{
"eventType": "CustomerAccountUpdateNotification",
"eventTime": "2014-09-27T05:46:25.0Z",
"eventId": "33211",
"event":
{
"customerAccount":
{
"id": "ca1234",
Following a whole representation of the Customer Account with all its attributes See Customer Account Resource.
}
}
} |
Payment Mean Notification UML:
| Anchor |
|---|
| _Toc404169832 |
|---|
| _Toc404169832 |
|---|
|
payment Mean Create Notification{
"eventType": "PaymentMeanCreateNotification",
"eventTime": "2014-09-27T05:46:25.0Z",
"eventId": "1134231",
"event":
{
"paymentMean":
{
"id": "11341",
Following a whole representation of the Payment Mean with all its attributes See Payment Mean Resource.
}
}
} |
| Anchor |
|---|
| _Toc404169833 |
|---|
| _Toc404169833 |
|---|
|
payment Mean Delete Notification{
"eventType": "PaymentMeanDeleteNotification",
"eventTime": "2014-09-27T05:46:25.0Z",
"eventId": "11231",
"event":
{
"paymentMean":
{
"id": "11341",
Following a whole representation of the Payment Mean with all its attributes See Payment Mean Resource.
}
}
} |
| Anchor |
|---|
| _Toc404169834 |
|---|
| _Toc404169834 |
|---|
|
payment Mean Update Notification{
"eventType": "PaymentMeanUpdateNotification",
"eventTime": "2014-09-27T05:46:25.0Z",
"eventId": "33211",
"event":
{
"paymentMean":
{
"id": "11341",
Following a whole representation of the Payment Mean with all its attributes See Payment Mean Resource.
}
}
} |