Jump to

• Request
• Response

Get an usage event

get

/crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}

Request

Path Parameters

• BatchNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• EventNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : subscriptionUsageEventBatches-usageEvents-item-response

Type: object

Show Source

• BatchNumber: string
  Title: Batch Number

  Maximum Length: 120

  The number of the batch associated with an usage event.
• CorpCurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The corporate currency code associated with the usage event.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created a usage event.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when a usage event was created.
• CurcyConvRateType: string
  Maximum Length: 30

  The currency conversion rate type associated with the usage event.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the usage event. A list of accepted values is defined in the FND_CURRENCIES_VL view for currency code
• Error: string
  Title: Error

  Maximum Length: 255

  The error message text for the usage event.
• EventEndTime: string (date-time)
  Title: Event End Time

  The date and time when a usage event ends.
• EventId: integer (int64)
  Title: Event Identifier

  The unique identifier of the event.
• EventNumber: string
  Title: Event Number

  Maximum Length: 120

  The alternate unique identifier of the event.
• EventRatingType: string
  Title: Event Rating Type

  Maximum Length: 30

  The event rating type of an event.
• EventStartTime: string (date-time)
  Title: Event Start Time

  The date and time when usage event starts.
• EventStatus: string
  Title: Event Status

  Maximum Length: 30

  The usage event processing status. The event status is used to segregate event records that are ready for processing and the ones that are on hold requiring further enrichment. The outcome of the pricing process is also recorded in the status. A list of accepted values is defined in the ORA_OSS_EVENT_STATUS lookup for usage event status.
• EventTimeZone: string
  Title: Event Time Zone

  Maximum Length: 50

  The usage event time zone.This is the Time Zone of the logged in user.
• EventType: string
  Title: Event Type

  Maximum Length: 30

  The usage event types that will be imported and processed by the pricing engine. A list of accepted values is defined in the ORA_OSS_EVENT_TYPES lookups for usage event type.
• EventTypeId: integer (int64)
  The unique identifier of the event type.
• FileName: string
  Title: File Name

  Maximum Length: 300

  The file name of the event.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when a usage event was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who has last updated a usage event.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the usage event.
• LeEventStartDate: string (date)
  Title: Start Date

  Read Only: true

  The legal entity date when usage event starts.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PricedOn: string (date-time)
  Title: Priced on Date

  The date on which the usage event is priced.
• RatingSource: string
  Title: Rating Source

  Maximum Length: 30

  The rating source of an usage event. This attributes gives information on whether the usage event is rated by subscription management or not.
• RelatedBatchId: integer (int64)
  Title: Related Batch ID

  The related batch ID of the event.
• RelatedBatchNumber: string
  Title: Related Batch Number

  Read Only: true

  Maximum Length: 120

  The related batch number of the event.
• RelatedEventId: integer (int64)
  Title: Related Event ID

  The related event ID of the event.
• RelatedEventNumber: string
  Title: Related Event Number

  Read Only: true

  Maximum Length: 120

  The related event number of the event.
• ReportedUsageQuantity: number
  Title: Reported Usage Quantity

  The reported usage quantity of the event.
• ReportedUsageUnitOfMeasure: string
  Title: Reported UOM

  Maximum Length: 3

  The reported unit of measure of the event such as Ea, FT, and GAL. A list of accepted values is defined in INV_UNITS_OF_MEASURE_VL for a usage unit of measure.
• ReverseFlag: boolean
  Title: Reverse

  Read Only: true

  Maximum Length: 1

  Indicates whether the event can be reversed or not.
• ServiceId: string
  Title: Service Identifier

  Maximum Length: 120

  The unique identifier of the service identifier.
• SourceInterfaceType: string
  Title: Source Interface Type

  Maximum Length: 30

  Default Value: ORA_OSS_SOURCE_API

  The source interface type of the event.
• SubscriptionCurrencyCode: string
  Title: Subscription Currency

  Read Only: true

  Maximum Length: 15

  The subscription currency associated with the usage event.
• SubscriptionProductPuid: string
  Title: Subscription Product PUID

  Maximum Length: 120

  The subscription product PUID which is unique for each product.
• SummarizedRatingFlag: boolean
  Title: Enable summarize rating

  Read Only: true

  Maximum Length: 1

  Indicates whether the events are eligible for summarized rating.
• UsageBatchId: integer (int64)
  Title: Batch ID

  The identifier of the batch associated with an usage event.
• usageCharges: array Subscription Usage Event Charges
  Title: Subscription Usage Event Charges

  The usage event charges resource is used to view, create, update, and delete an usage event charge. It provides details of the usage event charges associated with a subscription product.
• usageMessages: array Subscription Usage Event Messages
  Title: Subscription Usage Event Messages

  The usage event messages resource is used to view, create, update, and delete an usage event message.
• UsageQuantity: number
  Title: Usage Quantity

  The usage quantity of the event.
• UsageUnitOfMeasure: string
  Title: Usage UOM

  Maximum Length: 3

  The unit of measure of the event such as Ea, FT, and GAL. A list of accepted values is defined in the INV_UNITS_OF_MEASURE_VL view for a usage unit of measure.
• VolumeRatingFlag: boolean
  Title: Enable volume pricing

  Read Only: true

  Maximum Length: 1

  Indicates whether the events are eligible for volume rating.

{
    "type":"object",
    "properties":{
        "BatchNumber":{
            "title":"Batch Number",
            "maxLength":120,
            "type":"string",
            "description":"The number of the batch associated with an usage event.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the usage event.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created a usage event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when a usage event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the usage event.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the usage event. A list of accepted values is defined in the FND_CURRENCIES_VL view for currency code",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Error":{
            "title":"Error",
            "maxLength":255,
            "type":"string",
            "description":"The error message text for the usage event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "EventEndTime":{
            "title":"Event End Time",
            "type":"string",
            "description":"The date and time when a usage event ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "EventId":{
            "title":"Event Identifier",
            "type":"integer",
            "description":"The unique identifier of the event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ],
                "precision":18
            },
            "x-queryable":true
        },
        "EventNumber":{
            "title":"Event Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the event.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "EventRatingType":{
            "title":"Event Rating Type",
            "maxLength":30,
            "type":"string",
            "description":"The event rating type of an event.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EventStartTime":{
            "title":"Event Start Time",
            "type":"string",
            "description":"The date and time when usage event starts.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "EventStatus":{
            "title":"Event Status",
            "maxLength":30,
            "type":"string",
            "description":"The usage event processing status. The event status is used to segregate event records that are ready for processing and the ones that are on hold requiring further enrichment. The outcome of the pricing process is also recorded in the status. A list of accepted values is defined in the ORA_OSS_EVENT_STATUS lookup for usage event status.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventTimeZone":{
            "title":"Event Time Zone",
            "maxLength":50,
            "type":"string",
            "description":"The usage event time zone.This is the Time Zone of the logged in user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EventType":{
            "title":"Event Type",
            "maxLength":30,
            "type":"string",
            "description":"The usage event types that will be imported and processed by the pricing engine. A list of accepted values is defined in the ORA_OSS_EVENT_TYPES lookups for usage event type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventTypeId":{
            "type":"integer",
            "description":"The unique identifier of the event type.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":300,
            "type":"string",
            "description":"The file name of the event.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when a usage event was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the usage event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated a usage event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LeEventStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The legal entity date when usage event starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PricedOn":{
            "title":"Priced on Date",
            "type":"string",
            "description":"The date on which the usage event is priced.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "RatingSource":{
            "title":"Rating Source",
            "maxLength":30,
            "type":"string",
            "description":"The rating source of an usage event. This attributes gives information on whether the usage event is rated by subscription management or not.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelatedBatchId":{
            "title":"Related Batch ID",
            "type":"integer",
            "description":"The related batch ID of the event.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RelatedBatchNumber":{
            "title":"Related Batch Number",
            "maxLength":120,
            "type":"string",
            "description":"The related batch number of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelatedEventId":{
            "title":"Related Event ID",
            "type":"integer",
            "description":"The related event ID of the event.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RelatedEventNumber":{
            "title":"Related Event Number",
            "maxLength":120,
            "type":"string",
            "description":"The related event number of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReportedUsageQuantity":{
            "title":"Reported Usage Quantity",
            "type":"number",
            "description":"The reported usage quantity of the event.",
            "nullable":true,
            "x-queryable":false
        },
        "ReportedUsageUnitOfMeasure":{
            "title":"Reported UOM",
            "maxLength":3,
            "type":"string",
            "description":"The reported unit of measure of the event such as Ea, FT, and GAL. A list of accepted values is defined in INV_UNITS_OF_MEASURE_VL for a usage unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReverseFlag":{
            "title":"Reverse",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the event can be reversed or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ServiceId":{
            "title":"Service Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the service identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceInterfaceType":{
            "title":"Source Interface Type",
            "maxLength":30,
            "type":"string",
            "description":"The source interface type of the event.",
            "nullable":true,
            "default":"ORA_OSS_SOURCE_API",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionCurrencyCode":{
            "title":"Subscription Currency",
            "maxLength":15,
            "type":"string",
            "description":"The subscription currency associated with the usage event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The subscription product PUID which is unique for each product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SummarizedRatingFlag":{
            "title":"Enable summarize rating",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the events are eligible for summarized rating.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UsageBatchId":{
            "title":"Batch ID",
            "type":"integer",
            "description":"The identifier of the batch associated with an usage event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The usage quantity of the event.",
            "nullable":true,
            "x-queryable":false
        },
        "UsageUnitOfMeasure":{
            "title":"Usage UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of the event such as Ea, FT, and GAL. A list of accepted values is defined in the INV_UNITS_OF_MEASURE_VL view for a usage unit of measure.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VolumeRatingFlag":{
            "title":"Enable volume pricing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the events are eligible for volume rating.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "usageCharges":{
            "title":"Subscription Usage Event Charges",
            "type":"array",
            "description":"The usage event charges resource is used to view, create, update, and delete an usage event charge. It provides details of the usage event charges associated with a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEventBatches-usageEvents-usageCharges-item-response"
            }
        },
        "usageMessages":{
            "title":"Subscription Usage Event Messages",
            "type":"array",
            "description":"The usage event messages resource is used to view, create, update, and delete an usage event message.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEventBatches-usageEvents-usageMessages-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Subscription Usage Event Charges

Type: array

Title: Subscription Usage Event Charges

The usage event charges resource is used to view, create, update, and delete an usage event charge. It provides details of the usage event charges associated with a subscription product.

Show Source

• Array of: object subscriptionUsageEventBatches-usageEvents-usageCharges-item-response

{
    "title":"Subscription Usage Event Charges",
    "type":"array",
    "description":"The usage event charges resource is used to view, create, update, and delete an usage event charge. It provides details of the usage event charges associated with a subscription product.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEventBatches-usageEvents-usageCharges-item-response"
    }
}

Nested Schema : Subscription Usage Event Messages

Type: array

Title: Subscription Usage Event Messages

The usage event messages resource is used to view, create, update, and delete an usage event message.

Show Source

• Array of: object subscriptionUsageEventBatches-usageEvents-usageMessages-item-response

{
    "title":"Subscription Usage Event Messages",
    "type":"array",
    "description":"The usage event messages resource is used to view, create, update, and delete an usage event message.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEventBatches-usageEvents-usageMessages-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : subscriptionUsageEventBatches-usageEvents-usageCharges-item-response

Type: object

Show Source

• AllowanceAmount: number
  Title: Allowance Amount

  The allowance amount of the usage event charge.
• BilledAmount: number
  Title: Amount

  The billed amount of the usage event charge.
• ChargeCurrency: string
  Title: Currency

  Maximum Length: 15

  The currency of the usage event charge.
• ChargeDefinition: string
  Title: Charge Definitions

  Maximum Length: 30

  The charge definition associated with the usage event charge.
• ChargeDefinitionId: integer (int64)
  The identifier of the charge definition associated with the usage event charge.
• ChargeName: string
  Title: Charge Name

  Maximum Length: 120

  The name of the usage event charge.
• ConversionRate: number
  Title: Conversion Rate

  A multiplier used for converting a quantity from one unit of measure to another.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the usage event charge.
• CreationDate: string (date-time)
  Read Only: true

  The date when the usage event charge was created.
• EventId: integer (int64)
  Title: Event Identifier

  The unique identifier of the event to which this usage event charge is associated with.
• ExtendedAmount: number
  Title: Extended Amount

  The extended amount of the usage event charge.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the usage event charge was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the usage event charge.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the usage event charge.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number updated after every update of an usage event charge.
• ParentEntity: string
  Title: Reference Object

  Maximum Length: 30

  The parent entity associated with the usage event charge.
• ParentEntityId: integer (int64)
  Title: Reference Object ID

  The unique identifier of the parent entity associated with the usage event charge.
• PricedQuantity: number
  Title: Priced Quantity

  The quantity priced for an usage event charge.
• PricedQuantityUnitOfMeasure: string
  Title: Priced Quantity Unit of Measure

  Maximum Length: 3

  The unit of measure of the priced quantity of an usage event charge.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number associated with an usage event charge.
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The unique identifier of a subscription to which this usage event change belongs.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The PUID of a subscription product to which this usage event charge belongs.
• UsageChargeId: integer (int64)
  The unique identifier of the usage event charge.
• UsageChargePuid: string
  Title: Usage Charge PUID

  Maximum Length: 120

  The PUID of the usage event charge.
• UserReportedQuantity: number
  Title: User Reported Quantity

  The user-reported usage quantity for the event.
• UserReportedUnitOfMeasure: string
  Title: User Reported UOM

  Maximum Length: 3

  The user-reported unit of measure of the event such as Ea, FT, and GAL. A list of accepted values is defined in INV_UNITS_OF_MEASURE_VL for a usage unit of measure.

{
    "type":"object",
    "properties":{
        "AllowanceAmount":{
            "title":"Allowance Amount",
            "type":"number",
            "description":"The allowance amount of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "BilledAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The billed amount of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinition":{
            "title":"Charge Definitions",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition associated with the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The identifier of the charge definition associated with the usage event charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"A multiplier used for converting a quantity from one unit of measure to another.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the usage event charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the usage event charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventId":{
            "title":"Event Identifier",
            "type":"integer",
            "description":"The unique identifier of the event to which this usage event charge is associated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExtendedAmount":{
            "title":"Extended Amount",
            "type":"number",
            "description":"The extended amount of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the usage event charge was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the usage event charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the usage event charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of an usage event charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ParentEntity":{
            "title":"Reference Object",
            "maxLength":30,
            "type":"string",
            "description":"The parent entity associated with the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentEntityId":{
            "title":"Reference Object ID",
            "type":"integer",
            "description":"The unique identifier of the parent entity associated with the usage event charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricedQuantity":{
            "title":"Priced Quantity",
            "type":"number",
            "description":"The quantity priced for an usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "PricedQuantityUnitOfMeasure":{
            "title":"Priced Quantity Unit of Measure",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of the priced quantity of an usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number associated with an usage event charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The unique identifier of a subscription to which this usage event change belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The PUID of a subscription product to which this usage event charge belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageChargeId":{
            "type":"integer",
            "description":"The unique identifier of the usage event charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageChargePuid":{
            "title":"Usage Charge PUID",
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the usage event charge.",
            "nullable":false,
            "x-queryable":true
        },
        "UserReportedQuantity":{
            "title":"User Reported Quantity",
            "type":"number",
            "description":"The user-reported usage quantity for the event.",
            "nullable":true,
            "x-queryable":false
        },
        "UserReportedUnitOfMeasure":{
            "title":"User Reported UOM",
            "maxLength":3,
            "type":"string",
            "description":"The user-reported unit of measure of the event such as Ea, FT, and GAL. A list of accepted values is defined in INV_UNITS_OF_MEASURE_VL for a usage unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionUsageEventBatches-usageEvents-usageMessages-item-response

Type: object

Show Source

• AdditionalMessageText: string
  Title: Error

  Read Only: true

  Maximum Length: 255

  Parameterized error message text.
• BatchId: integer (int64)
  Title: Batch ID

  The identifier of the batch associated with an usage event.
• BatchNumber: string
  Title: Batch Number

  Read Only: true

  Maximum Length: 120

  The batch number associated with the usage event message.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the usage event message.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the usage event message was created.
• EventNumber: string
  Title: Event Number

  Read Only: true

  Maximum Length: 120

  The event number associated with the usage event message.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the usage event message was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the usage event message.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the usage event message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageName: string
  Title: Message Name

  Maximum Length: 30

  The name of the usage event message.
• MessageText: string
  Title: Message Text

  Maximum Length: 2000

  The text of the usage event message.
• MessageType: string
  Title: Message Type

  Maximum Length: 30

  The type of the usage event message.
• MessageUserDetails: string
  Title: Recommended Action

  Read Only: true

  Maximum Length: 4000

  Recommendation based on the message text.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The object version number updated after every update of an usage event message.
• ParentEntity: string
  Title: Reference Object

  Maximum Length: 30

  The parent entity associated with the usage event message.
• ParentEntityId: integer (int64)
  Title: Reference Object ID

  The unique identifier of the parent entity associated with the usage event message.
• TranslatedMessageText: string
  Title: Error

  Read Only: true

  Maximum Length: 240

  The error message text.
• UsageMessageId: integer (int64)
  Title: Usage Message

  The unique identifier of an usage event message.

{
    "type":"object",
    "properties":{
        "AdditionalMessageText":{
            "title":"Error",
            "maxLength":255,
            "type":"string",
            "description":"Parameterized error message text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchId":{
            "title":"Batch ID",
            "type":"integer",
            "description":"The identifier of the batch associated with an usage event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BatchNumber":{
            "title":"Batch Number",
            "maxLength":120,
            "type":"string",
            "description":"The batch number associated with the usage event message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the usage event message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the usage event message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventNumber":{
            "title":"Event Number",
            "maxLength":120,
            "type":"string",
            "description":"The event number associated with the usage event message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the usage event message was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the usage event message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the usage event message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "title":"Message Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the usage event message.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageText":{
            "title":"Message Text",
            "maxLength":2000,
            "type":"string",
            "description":"The text of the usage event message.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageType":{
            "title":"Message Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the usage event message.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageUserDetails":{
            "title":"Recommended Action",
            "maxLength":4000,
            "type":"string",
            "description":"Recommendation based on the message text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number updated after every update of an usage event message.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ParentEntity":{
            "title":"Reference Object",
            "maxLength":30,
            "type":"string",
            "description":"The parent entity associated with the usage event message.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentEntityId":{
            "title":"Reference Object ID",
            "type":"integer",
            "description":"The unique identifier of the parent entity associated with the usage event message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TranslatedMessageText":{
            "title":"Error",
            "maxLength":240,
            "type":"string",
            "description":"The error message text.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageMessageId":{
            "title":"Usage Message",
            "type":"integer",
            "description":"The unique identifier of an usage event message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

CurrencyCodeVA

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The following properties are defined on the LOV link relation:

• Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
• Display Attribute: Name

EventRatingTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_EVENTS_RATING_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: EventRatingType; Target Attribute: LookupCode
• Display Attribute: Meaning

EventStatusVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_EVENT_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: EventStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

EventTypeVA

Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes

The following properties are defined on the LOV link relation:

• Source Attribute: EventType; Target Attribute: EventType
• Display Attribute: EventType

RatingSourceVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_USAGE_RATING_SOURCE

The following properties are defined on the LOV link relation:

• Source Attribute: RatingSource; Target Attribute: LookupCode
• Display Attribute: Meaning

SourceInterfaceTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_EVENTS_SOURCE_IF_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: SourceInterfaceType; Target Attribute: LookupCode
• Display Attribute: Meaning

SubscriptionProductVA

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts

The following properties are defined on the LOV link relation:

• Source Attribute: SubscriptionProductPuid; Target Attribute: SubscriptionProductPuid
• Display Attribute: SubscriptionProductPuid

TimezoneVA

Operation: /fscmRestApi/resources/11.13.18.05/timezonesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: EventTimeZone; Target Attribute: TimezoneCode
• Display Attribute: TimezoneCode

UsageEventBatchesVA

Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches

Parameters:

• finder: UsageBatchesForCreateFinder

The following properties are defined on the LOV link relation:

• Source Attribute: BatchNumber; Target Attribute: BatchNumber
• Display Attribute: BatchNumber, BatchDescription

UsageEventErrorKeysVVOVA

Operation: /crmRestApi/resources/11.13.18.05/usageBatchErrors

The following properties are defined on the LOV link relation:

• Source Attribute: Error; Target Attribute: MessageName
• Display Attribute: MessageText

UsageUomVA

The following properties are defined on the LOV link relation:

• Source Attribute: ReportedUsageUnitOfMeasure; Target Attribute: UOMCode
• Display Attribute: UOM

usageCharges

Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}/child/usageCharges

Parameters:

• BatchNumber: $request.path.BatchNumber
• EventNumber: $request.path.EventNumber

The usage event charges resource is used to view, create, update, and delete an usage event charge. It provides details of the usage event charges associated with a subscription product.

usageMessages

Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}/child/usageMessages

Parameters:

• BatchNumber: $request.path.BatchNumber
• EventNumber: $request.path.EventNumber

The usage event messages resource is used to view, create, update, and delete an usage event message.

Back to Top