Create an empty rated used aggregation

post

https://api.instellix.io/v2/rated-usage-aggregations

Body Params

aggregationGroup

string

length ≤ 64

Used as an aggregation criterion. If not provided it will be filled by option.itemGroup. Will be mapped into lineItem.itemGroup during billing.
Size must be between 0 and 64.

aggregationPeriodTimestamp

date-time

required

Any point in time within the desired aggregation period. For example, the end date of a usage to be aggregated.
Must not be null.

contractIdent

string

required

length ≤ 100

Ident of the contract the aggregation belongs to.
Must not be blank.
Size must be between 0 and 100.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

currency

string

required

length ≥ 1

ISO-4217 currency code.
Must not be blank.

ident

string

required

length ≤ 100

Unique identifier.
Must not be blank.
Size must be between 0 and 100.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_-]*'.

productReferenceKey

string

required

length ≤ 100

External key that identifies a product. Must match the product reference key of a usage option of the contract.
Must not be blank.
Size must be between 0 and 100.

serviceLocation

object

required

Location where a service was used.

type

string

required

Type of the line item. Determines if this item was provided as a service to your customer (sales) or by your customer (self-billing).
Must not be null.

unit

string

required

Must not be null.
Must be one of:


PC
KWH
SECOND
MINUTE
HOUR
DAY
WEEK
MONTH
YEAR

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

201The request has been fulfilled, resulting in the creation of a new resource.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX