Jump to

• Request
• Response

Update an usage event charge

patch

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

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=
• UsageChargePuid(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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "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
            }
        },
        "ChargeCurrency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency of the usage event charge.",
            "nullable":true
        },
        "ChargeDefinition":{
            "title":"Charge Definitions",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition associated with the usage event charge.",
            "nullable":true
        },
        "BilledAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The billed amount of the usage event charge.",
            "nullable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the usage event charge.",
            "nullable":true
        },
        "PricedQuantity":{
            "title":"Priced Quantity",
            "type":"number",
            "description":"The quantity priced for an usage event charge.",
            "nullable":true
        },
        "ExtendedAmount":{
            "title":"Extended Amount",
            "type":"number",
            "description":"The extended amount of the usage event charge.",
            "nullable":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
            }
        },
        "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
            }
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The identifier of the charge definition associated with the usage event charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number associated with an usage event charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "AllowanceAmount":{
            "title":"Allowance Amount",
            "type":"number",
            "description":"The allowance amount of the usage event charge.",
            "nullable":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
            }
        },
        "ParentEntity":{
            "title":"Reference Object",
            "maxLength":30,
            "type":"string",
            "description":"The parent entity associated with the usage event charge.",
            "nullable":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
            }
        },
        "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
        }
    }
}

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-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":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the usage event charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserReportedQuantity":{
            "title":"User Reported Quantity",
            "type":"number",
            "description":"The user-reported usage quantity for the event.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeDefinition":{
            "title":"Charge Definitions",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition associated with the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ExtendedAmount":{
            "title":"Extended Amount",
            "type":"number",
            "description":"The extended amount of the usage event charge.",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "AllowanceAmount":{
            "title":"Allowance Amount",
            "type":"number",
            "description":"The allowance amount of the usage event charge.",
            "nullable":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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the usage event charge.",
            "nullable":false,
            "readOnly":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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the usage event charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeCurrency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency of the usage event charge.",
            "nullable":true,
            "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
        },
        "BilledAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The billed amount of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "PricedQuantity":{
            "title":"Priced Quantity",
            "type":"number",
            "description":"The quantity priced for an usage event charge.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "UsageChargePuid":{
            "title":"Usage Charge PUID",
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the usage event charge.",
            "nullable":false,
            "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
        },
        "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
        }
    }
}

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 : 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."
        }
    }
}

Back to Top