Jump to

• Request
• Response

Create a miscellaneous fee

post

/fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/miscellaneousFeeItems

Request

Path Parameters

• CartHeaderId(required): integer(int64)
  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:
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "required":[
        "FeeAttributeId"
    ],
    "type":"object",
    "properties":{
        "FeeAttributeId":{
            "title":"Fee Attribute ID",
            "type":"integer",
            "description":"The unique identifier of the miscellaneous fee attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "miscDiscounts":{
            "title":"Miscellaneous Discounts",
            "type":"array",
            "description":"The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.",
            "items":{
                "$ref":"#/components/schemas/carts-miscellaneousFeeItems-miscDiscounts-item-post-request"
            }
        }
    }
}

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

• Array of: object carts-miscellaneousFeeItems-miscDiscounts-item-post-request

{
    "title":"Miscellaneous Discounts",
    "type":"array",
    "description":"The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.",
    "items":{
        "$ref":"#/components/schemas/carts-miscellaneousFeeItems-miscDiscounts-item-post-request"
    }
}

Nested Schema : carts-miscellaneousFeeItems-miscDiscounts-item-post-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"80",
            "type":"string",
            "description":"Currency code for a cart item discount.",
            "nullable":true,
            "x-queryable":false
        },
        "DiscountName":{
            "title":"Discount Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of a discount applied to a cart item.",
            "nullable":true,
            "x-queryable":false
        },
        "DiscountAmount":{
            "title":"Discount Amount",
            "type":"number",
            "description":"Amount deducted from the original cost of a cart item.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":"80",
            "type":"string",
            "description":"Currency symbol for a cart item discount.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : carts-miscellaneousFeeItems-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "FeeAttributeLongDescription":{
            "title":"Fee Attribute Long Description",
            "maxLength":"240",
            "type":"string",
            "description":"The detailed description for the miscellaneous fee attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the miscellaneous item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the miscellaneous item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CartDetailStatus":{
            "title":"Detail Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the cart detail of the miscellaneous fee item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the miscellaneous item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FlatAmount":{
            "title":"Amount",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "miscDiscounts":{
            "title":"Miscellaneous Discounts",
            "type":"array",
            "description":"The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.",
            "items":{
                "$ref":"#/components/schemas/carts-miscellaneousFeeItems-miscDiscounts-item-response"
            }
        },
        "FeeId":{
            "title":"Fee ID",
            "type":"integer",
            "description":"The unique identifier for the fee to be charged to the student.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FeeAttributeTransactionDescription":{
            "title":"Fee Attribute Transaction Description",
            "maxLength":"100",
            "type":"string",
            "description":"The invoices and credit memos description.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeCategoryName":{
            "title":"Fee Category Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the fee category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "type":"string",
            "description":"The currency symbol associated with a miscellaneous fee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DiscountAmount":{
            "title":"Discount Amount",
            "type":"number",
            "description":"The numeric value of the discount amount given for a miscellaneous item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"38",
                "scale":"2"
            },
            "x-queryable":true
        },
        "FeeAttributeId":{
            "title":"Fee Attribute ID",
            "type":"integer",
            "description":"The unique identifier of the miscellaneous fee attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CartDetailId":{
            "title":"Miscellaneous Fee Cart ID",
            "type":"integer",
            "description":"The unique identifier of the cart detail of the miscellaneous fee item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with a miscellaneous fee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the miscellaneous item was last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : Miscellaneous Discounts

Type: array

Title: Miscellaneous Discounts

The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.

Show Source

• Array of: object carts-miscellaneousFeeItems-miscDiscounts-item-response

{
    "title":"Miscellaneous Discounts",
    "type":"array",
    "description":"The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.",
    "items":{
        "$ref":"#/components/schemas/carts-miscellaneousFeeItems-miscDiscounts-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 : carts-miscellaneousFeeItems-miscDiscounts-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"80",
            "type":"string",
            "description":"Currency code for a cart item discount.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DiscountName":{
            "title":"Discount Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of a discount applied to a cart item.",
            "nullable":true,
            "x-queryable":false
        },
        "DiscountAmount":{
            "title":"Discount Amount",
            "type":"number",
            "description":"Amount deducted from the original cost of a cart item.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":"80",
            "type":"string",
            "description":"Currency symbol for a cart item discount.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

MiscellaneousFeeLOV

Operation: /fscmRestApi/resources/11.13.18.05/miscellaneousFees

Parameters:

• finder: MiscellaneousFeeTypeFinder

The following properties are defined on the LOV link relation:

• Source Attribute: FeeAttributeId; Target Attribute: FeeAttributeId
• Display Attribute: FeeAttributeLongDescription

miscDiscounts

Operation: /fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/miscellaneousFeeItems/{CartDetailId}/child/miscDiscounts

Parameters:

• CartDetailId: $request.path.CartDetailId
• CartHeaderId: $request.path.CartHeaderId

The miscellaneous discounts resource provides a list of discounts associated with a miscellaneous fee.

Back to Top