Create a miscellaneous fee
post
/fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/miscellaneousFeeItems
Request
Path Parameters
-
CartHeaderId(required): integer(int64)
The unique identifier of the shopping cart header.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
FeeAttributeId(required): integer
(int64)
Title:
Fee Attribute ID
The unique identifier of the miscellaneous fee attribute. -
miscDiscounts: array
Miscellaneous Discounts
Title:
Miscellaneous Discounts
The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.
Nested Schema : Miscellaneous Discounts
Type:
array
Title:
Miscellaneous Discounts
The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.
Show Source
Nested Schema : carts-miscellaneousFeeItems-miscDiscounts-item-post-request
Type:
Show Source
object
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:80
Currency code for a cart item discount. -
CurrencySymbol: string
Title:
Currency Symbol
Maximum Length:80
Currency symbol for a cart item discount. -
DiscountAmount: number
Title:
Discount Amount
Amount deducted from the original cost of a cart item. -
DiscountName: string
Title:
Discount Name
Maximum Length:80
Name of a discount applied to a cart item.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : carts-miscellaneousFeeItems-item-response
Type:
Show Source
object
-
CartDetailId: integer
(int64)
Title:
Miscellaneous Fee Cart ID
Read Only:true
The unique identifier of the cart detail of the miscellaneous fee item. -
CartDetailStatus: string
Title:
Detail Status
Read Only:true
Maximum Length:30
The status of the cart detail of the miscellaneous fee item. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the miscellaneous item. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the miscellaneous item was created. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
The currency code associated with a miscellaneous fee. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
The currency symbol associated with a miscellaneous fee. -
DiscountAmount: number
Title:
Discount Amount
Read Only:true
The numeric value of the discount amount given for a miscellaneous item. -
FeeAttributeId: integer
(int64)
Title:
Fee Attribute ID
The unique identifier of the miscellaneous fee attribute. -
FeeAttributeLongDescription: string
Title:
Fee Attribute Long Description
Read Only:true
Maximum Length:240
The detailed description for the miscellaneous fee attribute. -
FeeAttributeTransactionDescription: string
Title:
Fee Attribute Transaction Description
Read Only:true
Maximum Length:100
The invoices and credit memos description. -
FeeCategoryName: string
Title:
Fee Category Name
Read Only:true
Maximum Length:50
The name of the fee category. -
FeeId: integer
(int64)
Title:
Fee ID
Read Only:true
The unique identifier for the fee to be charged to the student. -
FlatAmount: number
Title:
Amount
Read Only:true
The amount that will be charged for the fee. For example, a flat fee amount could be charged regardless of whether the student is an undergraduate or graduate student. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the miscellaneous item was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the miscellaneous item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
miscDiscounts: array
Miscellaneous Discounts
Title:
Miscellaneous Discounts
The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Miscellaneous Discounts
Type:
array
Title:
Miscellaneous Discounts
The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : carts-miscellaneousFeeItems-miscDiscounts-item-response
Type:
Show Source
object
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:80
Currency code for a cart item discount. -
CurrencySymbol: string
Title:
Currency Symbol
Maximum Length:80
Currency symbol for a cart item discount. -
DiscountAmount: number
Title:
Discount Amount
Amount deducted from the original cost of a cart item. -
DiscountName: string
Title:
Discount Name
Maximum Length:80
Name of a discount applied to a cart item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- MiscellaneousFeeLOV
-
Parameters:
- finder:
MiscellaneousFeeTypeFinder
The following properties are defined on the LOV link relation:- Source Attribute: FeeAttributeId; Target Attribute: FeeAttributeId
- Display Attribute: FeeAttributeLongDescription
- finder:
- miscDiscounts
-
Parameters:
- CartDetailId:
$request.path.CartDetailId
- CartHeaderId:
$request.path.CartHeaderId
The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee. - CartDetailId: