...
- What status and exception codes are returned.
- Returns HTTP/1.1 status code 201 if the request was successful.
Any other special return and/or exception codes.
Attribute name
Patchable
error
RatingType
No
Name
Y
Valid for. startDateTime
Y
Valid for:endDateTime
Y
After the start date
CustomerAccount.id
Y
Should exist
CustomerBillingCycleSpecification.id
Y
CustomerBillFormat.id
Y
CustomerBillPresentationMedia.id
Y
Currency code
Y
PaymentMean.id
Y
RelatedParty.id
Y
Bill receiver is mandatory
State
Y
Transition state should be valid (need further work in financial entities)
BillingAccountBalance
N
No additional complex rules for patching attributes.
Example : Update BillingAccount 65 : change of customer bill presentation media.REQUEST
PATCH billingManagement/billingAccount/65
Content-type: application/json
{
"customerBillPresentationMedia": {
"id": "78",
"href": http://serverlocation:port/billingManagement/customerBillPresentationMedia/78"}
}RESPONSE
201
Content-Type: application/json
{
"customerBillPresentationMedia": {
"id": "78",
"href": http://serverlocation:port/billingManagement/customerBillPresentationMedia/78",
"name": "Paper invoice"
}
}
POST API/bILLING Management/BillingAccountThis operation is used to create a BillingAccount.Anchor _Toc404178548 _Toc404178548
Pre-conditions:
We assume that the customer and the customer account have been already defined. The bill receiver contact also exists.
All reference data have been already defined.
Description :- Provides an overall description of the Operation
- Describes the input representation of the <resource> instance.
- Describes if the resource represents a managed entity or a task.
- Describes the structure of the identifier.
Mandatory attributes are :
Attribute name | Mandatory | Default | error |
RatingType | N | Postpaid |
|
Name | N | Customer name |
|
Valid for. startDateTime | N | Today | Valid date not earlier than one bill cycle in the past |
Valid for:endDateTime | N |
| After the start date |
CustomerAccount.id | Y |
| Should exist (see precondition) |
CustomerBillingCycleSpecification.id | N | Bill issuer choice |
|
CustomerBillFormat.id | N | Standard invoice |
|
CustomerBillPresentationMedia.id | N | Electronic invoice |
|
Currency code | N | National currency |
|
PaymentMean | N | Customer choice |
|
RelatedParty.id | Y |
| Bill receiver is mandatory (see precondition) |
BillingAccountBalance.id | N |
|
|
...
Mandatory attributes are :
Attribute name | Mandatory | Default | error |
date | N | Today |
|
description | N |
|
|
type | Y |
| Recurring, non recurring, usage, … |
currencyCode | Y |
|
|
taxIncludedAmount | N |
|
|
taxExcludedAmount | Y |
|
|
taxRate.amount | N |
|
|
service.id | Y |
| 400 if service.id is invalid |
service.idType | N |
|
|
productSpecification.name | Y |
|
|
productSpecification.productNumber | N |
|
|
period.startPeriod | N |
| Only mandatory for recurring charge |
period.endPeriod | N |
| Only mandatory for recurring charge |
...