Jump to

• Request
• Response
• Examples

Get one charge

get

/fscmRestApi/resources/11.13.18.05/customerAssets/{AssetId}/child/AssetCharge/{AssetChargeId}

Request

Path Parameters

• AssetChargeId(required): integer(int64)
  Value that uniquely identifies the asset charge. The application creates this value when it creates the asset charge. This attribute is read-only.
• AssetId(required): integer(int64)
  Value that uniquely identifies the asset. The application creates this value from the asset number when it creates the asset. This attribute is read-only.

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

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 : customerAssets-AssetCharge-item-response

Type: object

Show Source

• AssetChargeId: integer (int64)
  Value that uniquely identifies the asset charge. The application creates this value when it creates the asset charge. This attribute is read-only.
• AssetId: integer (int64)
  Value that uniquely identifies the asset that the application charges. The application uses the asset that the charge references to determine the value for this attribute. This attribute is read-only.
• ChargeComponentsRollupFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: the charge component represents the aggregated value of the rollup charge. N: the charge component does not represent this value. The default value is N.
• ChargeDefinitionCode: string
  Maximum Length: 30

  Abbreviation that identifies the definition for the pricing charge. This attribute is required to define the charge for asset pricing. You cannot update this attribute.
• ChargesRollupFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: the pricing charge is a rollup charge. N: the pricing charge is not a rollup charge. The default value is N.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that uniquely identifies the currency that the pricing charge uses. This attribute is required to define the charge for asset pricing. You can update this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PricedQuantityUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the quantity that the application prices. This attribute is required to define the charge for asset pricing. You can update this attribute.
• PriceElementCode: string
  Maximum Length: 30

  Abbreviation that identifies the pricing element of the pricing charge. This attribute is required to define the charge for asset pricing. You can update this attribute.
• PriceElementUsageCode: string
  Maximum Length: 30

  Abbreviation that indicates whether the unit price in the pricing element is the list price or the net price. This attribute is optional to define the charge for asset pricing. You can update this attribute.
• PricePeriodicityCode: string
  Maximum Length: 30

  Abbreviation that identifies the recurring timeframe that the application uses to price the charge, such as month or year. This attribute is optional to define the charge for asset pricing. You can update this attribute.
• PrimaryFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: the charge is a primary charge. N: the charge is not a primary charge. The default value is N.
• TaxIncludedFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: the asset price includes taxes. N: the asset price does not include taxes. The default value is N.
• UnitPrice: number
  Unit price of the asset. Current price of the asset or price that the organization used when it sold the asset. This attribute is optional to define the charge for asset pricing. You can update this attribute.

{
    "type":"object",
    "properties":{
        "PricePeriodicityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the recurring timeframe that the application uses to price the charge, such as month or year. This attribute is optional to define the charge for asset pricing. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset charge. The application creates this value when it creates the asset charge. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values. Y: the charge is a primary charge. N: the charge is not a primary charge. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "PricedQuantityUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the quantity that the application prices. This attribute is required to define the charge for asset pricing. You can update this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "TaxIncludedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values. Y: the asset price includes taxes. N: the asset price does not include taxes. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the definition for the pricing charge. This attribute is required to define the charge for asset pricing. You cannot update this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ChargesRollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values. Y: the pricing charge is a rollup charge. N: the pricing charge is not a rollup charge. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the currency that the pricing charge uses. This attribute is required to define the charge for asset pricing. You can update this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "PriceElementCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the pricing element of the pricing charge. This attribute is required to define the charge for asset pricing. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "type":"number",
            "description":"Unit price of the asset. Current price of the asset or price that the organization used when it sold the asset. This attribute is optional to define the charge for asset pricing. You can update this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "PriceElementUsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that indicates whether the unit price in the pricing element is the list price or the net price. This attribute is optional to define the charge for asset pricing. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargeComponentsRollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values. Y: the charge component represents the aggregated value of the rollup charge. N: the charge component does not represent this value. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset that the application charges. The application uses the asset that the charge references to determine the value for this attribute. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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

Examples

This example describes how to get one asset charge from one customer asset.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/customerAssets/AssetId/child/AssetCharge/AssetChargeId"

For example, the following command gets asset charge 300100118655268 from customer asset 100100055273349:

curl -u username:password "https://servername/fscmRestApi/resources/version/customerAssets/100100055273349/child/AssetCharge/300100118655268"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
            "AssetChargeId": 300100118655268,
            "AssetId": 100100055273349,
            "ChargeComponentsRollupFlag": true,
            "ChargeDefinitionCode": "ED",
            "ChargesRollupFlag": true,
            "CurrencyCode": "USD",
            "PriceElementCode": null,
            "PriceElementUsageCode": null,
            "PricePeriodicityCode": null,
            "PricedQuantityUOMCode": "EY",
            "PrimaryFlag": true,
            "TaxIncludedFlag": true,
            "UnitPrice": 1
}

Back to Top