Jump to

• Request
• Response
• Examples

Get Asset Charges

get

/rest/v19/assets/{id}/charges

This operation retrieves all charges of the specified asset.

Request

Path Parameters

• id(required): integer(int64)

Query Parameters

• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderby: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "ASC" or "DESC". Specify "ASC" for ascending and "DESC" for descending. The default value is "ASC". For example, ?orderby=field1:ASC,field2:DESC.
• q: string
  Filter (a ???where???clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : ResponseCollectionModel_assetChargeBean

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array items
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/assetChargeBean"
            }
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object assetChargeBean

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/assetChargeBean"
    }
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : assetChargeBean

Type: object

Show Source

• applyTo: string()
  Title: Apply To

  Indicates what this charge applies to
• assetKey: string()
  Title: Asset Key
• chargeDefIntegrationId: string()
  Title: Charge Definition Integration Id

  The charge definition code in the integrated order management system
• chargeName: string()
  Title: Charge Name

  Name of the charge
• chargeSequenceNumber: integer(int64)
• chargeTypeCode(required): string()
  Title: Charge Type Code
• contractDiscountAmount: Contract Discount Amount
  Title: Contract Discount Amount

  Discount amount based on contract
• contractListAmount: Contract List Amount
  Title: Contract List Amount

  List amount based on contract
• contractNetAmount: Contract Net Amount
  Title: Contract Net Amount

  Net amount based on contract
• customDiscountAmount: Custom Discount Amount
  Title: Custom Discount Amount

  Amount of custom discount
• customDiscountType: string()
  Title: Custom Discount Type

  Type of custom discount applied
• dateAdded: string()
  Title: Date Added

  Read Only: true

  Last modified date of Asset Charge Bean.
• dateModified: string()
  Title: Date Modified

  Read Only: true

  Creation date of the Asset Charge Bean.
• dynamicPricingType: string()
  Title: Dynamic Pricing Type

  Type of dynamic pricing
• extendedDiscountAmount: Extended Discount Amount
  Title: Extended Discount Amount

  Total extended discount amount
• id: integer()
  Title: id

  Read Only: true
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• listAmount: List Amount
  Title: List Amount

  The list amount for this charge
• netAmount: Net Amount
  Title: Net Amount

  Total net amount
• netPrice: Net Price
  Title: Net Price

  Price after applying discounts
• pricePeriodCode: string()
  Title: Price Period Code

  Code representing the pricing period
• priceTypeCode(required): string()
  Title: Price Type Code
• priceUom: string()
  Title: Price UOM

  Unit of measure for the price
• primaryFlag: boolean()
  Title: Primary Flag

  Indicates if this is the primary charge.
• rateCardStructure: string()
  Title: Rate Card Structure

  Structure of the rate card
• unitPrice: Unit Price
  Title: Unit Price

  Price per unit

{
    "required":[
        "chargeTypeCode",
        "priceTypeCode"
    ],
    "properties":{
        "id":{
            "type":"integer",
            "format":"",
            "description":"",
            "title":"id",
            "readOnly":true
        },
        "assetKey":{
            "type":"string",
            "format":"",
            "description":"",
            "title":"Asset Key"
        },
        "chargeSequenceNumber":{
            "type":"integer",
            "format":"int64"
        },
        "dateAdded":{
            "type":"string",
            "format":"",
            "description":"Last modified date of Asset Charge Bean.",
            "title":"Date Added",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"",
            "description":"Creation date of the Asset Charge Bean.",
            "title":"Date Modified",
            "readOnly":true
        },
        "primaryFlag":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if this is the primary charge.",
            "title":"Primary Flag"
        },
        "applyTo":{
            "type":"string",
            "format":"",
            "description":"Indicates what this charge applies to",
            "title":"Apply To"
        },
        "chargeName":{
            "type":"string",
            "format":"",
            "description":"Name of the charge",
            "title":"Charge Name"
        },
        "chargeTypeCode":{
            "type":"string",
            "format":"",
            "description":"",
            "title":"Charge Type Code"
        },
        "priceTypeCode":{
            "type":"string",
            "format":"",
            "description":"",
            "title":"Price Type Code"
        },
        "pricePeriodCode":{
            "type":"string",
            "format":"",
            "description":"Code representing the pricing period",
            "title":"Price Period Code"
        },
        "priceUom":{
            "type":"string",
            "format":"",
            "description":"Unit of measure for the price",
            "title":"Price UOM"
        },
        "unitPrice":{
            "format":"",
            "description":"Price per unit",
            "title":"Unit Price",
            "allOf":[
                {
                    "$ref":"#/definitions/amountBean"
                }
            ]
        },
        "listAmount":{
            "format":"",
            "description":"The list amount for this charge",
            "title":"List Amount",
            "allOf":[
                {
                    "$ref":"#/definitions/amountBean"
                }
            ]
        },
        "customDiscountType":{
            "type":"string",
            "format":"",
            "description":"Type of custom discount applied",
            "title":"Custom Discount Type"
        },
        "customDiscountAmount":{
            "format":"",
            "description":"Amount of custom discount",
            "title":"Custom Discount Amount",
            "allOf":[
                {
                    "$ref":"#/definitions/amountBean"
                }
            ]
        },
        "extendedDiscountAmount":{
            "format":"",
            "description":"Total extended discount amount",
            "title":"Extended Discount Amount",
            "allOf":[
                {
                    "$ref":"#/definitions/amountBean"
                }
            ]
        },
        "netPrice":{
            "format":"",
            "description":"Price after applying discounts",
            "title":"Net Price",
            "allOf":[
                {
                    "$ref":"#/definitions/amountBean"
                }
            ]
        },
        "netAmount":{
            "format":"",
            "description":"Total net amount",
            "title":"Net Amount",
            "allOf":[
                {
                    "$ref":"#/definitions/amountBean"
                }
            ]
        },
        "contractDiscountAmount":{
            "format":"",
            "description":"Discount amount based on contract",
            "title":"Contract Discount Amount",
            "allOf":[
                {
                    "$ref":"#/definitions/amountBean"
                }
            ]
        },
        "contractNetAmount":{
            "format":"",
            "description":"Net amount based on contract",
            "title":"Contract Net Amount",
            "allOf":[
                {
                    "$ref":"#/definitions/amountBean"
                }
            ]
        },
        "contractListAmount":{
            "format":"",
            "description":"List amount based on contract",
            "title":"Contract List Amount",
            "allOf":[
                {
                    "$ref":"#/definitions/amountBean"
                }
            ]
        },
        "rateCardStructure":{
            "type":"string",
            "format":"",
            "description":"Structure of the rate card",
            "title":"Rate Card Structure"
        },
        "dynamicPricingType":{
            "type":"string",
            "format":"",
            "description":"Type of dynamic pricing",
            "title":"Dynamic Pricing Type"
        },
        "chargeDefIntegrationId":{
            "type":"string",
            "format":"",
            "description":"The charge definition code in the integrated order management system",
            "title":"Charge Definition Integration Id"
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Contract Discount Amount

Title: Contract Discount Amount

Discount amount based on contract

Match All

Discount amount based on contract

Show Source

• object amountBean

{
    "format":"",
    "description":"Discount amount based on contract",
    "title":"Contract Discount Amount",
    "allOf":[
        {
            "$ref":"#/definitions/amountBean"
        }
    ]
}

Nested Schema : Contract List Amount

Title: Contract List Amount

List amount based on contract

Match All

List amount based on contract

Show Source

• object amountBean

{
    "format":"",
    "description":"List amount based on contract",
    "title":"Contract List Amount",
    "allOf":[
        {
            "$ref":"#/definitions/amountBean"
        }
    ]
}

Nested Schema : Contract Net Amount

Title: Contract Net Amount

Net amount based on contract

Match All

Net amount based on contract

Show Source

• object amountBean

{
    "format":"",
    "description":"Net amount based on contract",
    "title":"Contract Net Amount",
    "allOf":[
        {
            "$ref":"#/definitions/amountBean"
        }
    ]
}

Nested Schema : Custom Discount Amount

Title: Custom Discount Amount

Amount of custom discount

Match All

Amount of custom discount

Show Source

• object amountBean

{
    "format":"",
    "description":"Amount of custom discount",
    "title":"Custom Discount Amount",
    "allOf":[
        {
            "$ref":"#/definitions/amountBean"
        }
    ]
}

Nested Schema : Extended Discount Amount

Title: Extended Discount Amount

Total extended discount amount

Match All

Total extended discount amount

Show Source

• object amountBean

{
    "format":"",
    "description":"Total extended discount amount",
    "title":"Extended Discount Amount",
    "allOf":[
        {
            "$ref":"#/definitions/amountBean"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : List Amount

Title: List Amount

The list amount for this charge

Match All

The list amount for this charge

Show Source

• object amountBean

{
    "format":"",
    "description":"The list amount for this charge",
    "title":"List Amount",
    "allOf":[
        {
            "$ref":"#/definitions/amountBean"
        }
    ]
}

Nested Schema : Net Amount

Title: Net Amount

Total net amount

Match All

Total net amount

Show Source

• object amountBean

{
    "format":"",
    "description":"Total net amount",
    "title":"Net Amount",
    "allOf":[
        {
            "$ref":"#/definitions/amountBean"
        }
    ]
}

Nested Schema : Net Price

Title: Net Price

Price after applying discounts

Match All

Price after applying discounts

Show Source

• object amountBean

{
    "format":"",
    "description":"Price after applying discounts",
    "title":"Net Price",
    "allOf":[
        {
            "$ref":"#/definitions/amountBean"
        }
    ]
}

Nested Schema : Unit Price

Title: Unit Price

Price per unit

Match All

Price per unit

Show Source

• object amountBean

{
    "format":"",
    "description":"Price per unit",
    "title":"Unit Price",
    "allOf":[
        {
            "$ref":"#/definitions/amountBean"
        }
    ]
}

Nested Schema : amountBean

Type: object

Show Source

• amount: number()
  Title: Amount

  Amount
• currencyCode: string()
  Title: Currency Code

  Currency Code

{
    "properties":{
        "amount":{
            "type":"number",
            "format":"",
            "description":"Amount",
            "title":"Amount"
        },
        "currencyCode":{
            "type":"string",
            "format":"",
            "description":"Currency Code",
            "title":"Currency Code"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve all charges for the specified asset by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET  -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/assets/51587512/charges

Response Body Sample

{
  "offset": 0,
  "limit": 1000,
  "count": 1,
  "hasMore": false,
  "items": [{
      "id": 51587516,
      "assetKey": "abo_4d93b451-0ce6-4df3-8a08-e725f1c67bd3",
      "chargeSequenceNumber": 1,
      "dateAdded": "2025-08-28T03:43:21Z",
      "dateModified": "2025-08-28T03:43:21Z",
      "primaryFlag": true,
      "applyTo": "Price",
      "chargeTypeCode": "ORA_SALE",
      "priceTypeCode": "One Time",
      "unitPrice": {
        "amount": 1888,
        "currencyCode": "USD"
      },
      "listAmount": {
        "amount": 1888,
        "currencyCode": "USD"
      },
      "customDiscountAmount": {
        "amount": 0,
        "currencyCode": "USD"
      },
      "extendedDiscountAmount": {
        "amount": 0,
        "currencyCode": "USD"
      },
      "netPrice": {
        "amount": 1888,
        "currencyCode": "USD"
      },
      "netAmount": {
        "amount": 1888,
        "currencyCode": "USD"
      },
      "contractDiscountAmount": {
        "amount": 0,
        "currencyCode": "USD"
      },
      "contractNetAmount": {
        "amount": 1888,
        "currencyCode": "USD"
      },
      "contractListAmount": {
        "amount": 1888,
        "currencyCode": "USD"
      },
      "chargeDefIntegrationId": "QP_SALE_PRICE",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/assets/51587512/charges/51587516"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/assets/51587512/charges"
        }
      ]
    }
  ],
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v19/assets/51587512/charges"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/assets/51587512/charges?offset=0&limit=1000"
    }
  ]
}

Back to Top