Create a Billing Cycle Specification
post
/billingCycleSpecification
The operation creates a BillingCycleSpecification entity.
Request
Query Parameters
-
fields: string
The comma-separated properties to be provided in response.
Supported Media Types
- application/json
Nested Schema : BillingCycleSpecificationOracle_FVO
Match All
A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
-
object
allOf
Entity_FVO
The Base entity schema for use in TMForum Open-APIs Property.
-
object
BillingCycleSpecificationOracle_FVO-allOf[1]
A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Nested Schema : BillingCycleSpecification_FVO
Match All
A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
-
object
allOf
Entity_FVO
The Base entity schema for use in TMForum Open-APIs Property.
-
object
BillingCycleSpecification_FVO-allOf[1]
A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Nested Schema : Entity_FVO
Type:
objectThe Base entity schema for use in TMForum Open-APIs Property.
Match All
The Base entity schema for use in TMForum Open-APIs Property.
The Base entity schema for use in TMForum Open-APIs Property.
Show Source
-
object
Extensible_FVO
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Addressable_FVO
The base schema for adressable entities.
Nested Schema : Extensible_FVO
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The definition of the super-class, when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Addressable_FVO
Type:
objectThe base schema for adressable entities.
Show Source
-
id: string
The unique identifier.
Nested Schema : BillingCycleSpecificationOracle_FVO-allOf[1]
Type:
objectA detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
-
billingDateShift: integer
An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
-
description: string
An explanation regarding this billing cycle specification
-
frequency: string
Allowed Values:
[ "monthly", "bi-monthly", "quarterly", "semiyearly", "yearly" ]Frequency of the billing cycle (monthly for instance) -
name(required): string
A short descriptive name
-
paymentDueDateOffset: integer
An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
Nested Schema : BillingCycleSpecification_FVO-allOf[1]
Type:
objectA detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
-
billingDateShift: integer
An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
-
description: string
An explanation regarding this billing cycle specification
-
frequency: string
Frequency of the billing cycle (monthly for instance)
-
name(required): string
A short descriptive name
-
paymentDueDateOffset: integer
An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
Examples
Back to Top
Response
201 Response
The specification has been created.
Nested Schema : BillingCycleSpecification
Match All
The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
-
object
allOf
Entity
The Base entity schema for use in TMForum Open-APIs Property.
-
object
BillingCycleSpecification-allOf[1]
The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Nested Schema : BillingCycleSpecificationOracle
Match All
A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
-
object
allOf
Entity
The Base entity schema for use in TMForum Open-APIs Property.
-
object
BillingCycleSpecificationOracle-allOf[1]
A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Nested Schema : Entity
Type:
objectThe Base entity schema for use in TMForum Open-APIs Property.
Match All
The Base entity schema for use in TMForum Open-APIs Property.
The Base entity schema for use in TMForum Open-APIs Property.
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Addressable
The base schema for adressable entities.
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Addressable
Type:
objectThe base schema for adressable entities.
Show Source
-
href: string
The hyperlink reference.
-
id: string
The unique identifier.
Nested Schema : BillingCycleSpecification-allOf[1]
Type:
objectThe detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
-
billingDateShift: integer
The offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
-
description: string
An explanation regarding this billing cycle specification.
-
frequency: string
Frequency of the billing cycle (monthly for instance).
-
name: string
The short descriptive name
-
paymentDueDateOffset: integer
An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
Nested Schema : BillingCycleSpecificationOracle-allOf[1]
Type:
objectA detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
-
billingDateShift: integer
-
frequency: string
Allowed Values:
[ "monthly", "bi-monthly", "quarterly", "semiyearly", "yearly" ]Frequency of the billing cycle (monthly for instance) -
name: string
A short descriptive name
-
paymentDueDateOffset: integer
An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
Examples
202 Response
The request has been accepted for processing, but the processing is not yet complete.
400 Response
The server received a bad request.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
401 Response
The request was not authorized.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
403 Response
The request was forbidden.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
404 Response
The requested resource cannot be found.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
405 Response
The method is not allowed.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
409 Response
The request could not be processed due to a conflict with the existing state of the resource.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
500 Response
THe system has encountered an internal server error.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
501 Response
The request was not implemented.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
503 Response
The service is unavailable.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
Examples
The following example shows how to create a BillingCycleSpecification entity by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.
The -d option specifies the file to attach as the request body.
curl -X POST 'http://host:port/brm/accountManagement/version/billingCycleSpecification/' -d @createBillingCycleSpecification.json
Example Request Body for a BillingCycleSpecification Entity
The following is an example of the request body.
{
"@type": "BillingCycleSpecification",
"name": "Post BCS-1-test-005",
"description": "testing desc",
"billingDateShift": 4,
"frequency": "yearly",
"paymentDueDateOffset": 30,
"id": "bcs-test001"
}
Example Response Body for a BillingCycleSpecification Entity
The following is an example of the response body in JSON format.
{
"id": "0.0.0.1+-config-bill_cycle_specification+44859",
"href": "https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+44859",
"@type": "BillingCycleSpecification",
"name": "Post BCS-1-test-005",
"description": "testing desc",
"billingDateShift": 4,
"frequency": "yearly",
"paymentDueDateOffset": 30
}