Jump to

• Request
• Response

Create a fee instance

post

/fscmRestApi/resources/11.13.18.05/hedFeeInstances

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllowDiscountFlag(required): boolean
  Title: Allow Discount

  Maximum Length: 1

  Flag to indicate if discount is allowed for the fee or not. If set to yes, discount is allowed.
• EndDate: string (date)
  Title: Instance End Date

  End date of the fee instance.
• FeeCode(required): string
  Title: Fee Code

  Maximum Length: 30

  Code of fee instance.
• FeeDescription(required): string
  Title: Description

  Maximum Length: 240

  Description of the fee.
• FeeId(required): integer (int64)
  Title: Fee ID

  Unique identifier of the fee.
• FeeInstanceCode: string
  Title: Instance Code

  Maximum Length: 30

  Code of the fees.
• FeeName: string
  Title: Fee Name

  Maximum Length: 50

  Name of the fee.
• FeeTypeCode: string
  Title: Fee Type Code

  Maximum Length: 30

  Code of the fee type.
• FeeTypeId(required): integer
  Title: Fee Type

  Unique identifier of the fee type.
• FlatAmount: number
  Title: Amount

  Default Value: 0

  The amount setup for the fee instance.
• StartDate(required): string (date)
  Title: Instance Start Date

  Start date of the fee instance.
• tagAssignments: array Tag Assignments
  Title: Tag Assignments

  Tags provide a way to classify, group, or process fees as well as report on fee transactions.

{
    "required":[
        "AllowDiscountFlag",
        "FeeCode",
        "FeeDescription",
        "FeeId",
        "FeeTypeId",
        "StartDate"
    ],
    "type":"object",
    "properties":{
        "AllowDiscountFlag":{
            "title":"Allow Discount",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to indicate if discount is allowed for the fee or not. If set to yes, discount is allowed.",
            "nullable":false
        },
        "EndDate":{
            "title":"Instance End Date",
            "type":"string",
            "description":"End date of the fee instance.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FeeCode":{
            "title":"Fee Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of fee instance.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "FeeId"
                ]
            }
        },
        "FeeDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the fee.",
            "nullable":false
        },
        "FeeId":{
            "title":"Fee ID",
            "type":"integer",
            "description":"Unique identifier of the fee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FeeInstanceCode":{
            "title":"Instance Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the fees.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FeeName":{
            "title":"Fee Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the fee.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FeeTypeCode":{
            "title":"Fee Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the fee type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FeeTypeId":{
            "title":"Fee Type",
            "type":"integer",
            "description":"Unique identifier of the fee type.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "FeeTypeCode"
                ]
            }
        },
        "FlatAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount setup for the fee instance.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "StartDate":{
            "title":"Instance Start Date",
            "type":"string",
            "description":"Start date of the fee instance.",
            "format":"date",
            "nullable":false
        },
        "tagAssignments":{
            "title":"Tag Assignments",
            "type":"array",
            "description":"Tags provide a way to classify, group, or process fees as well as report on fee transactions.",
            "items":{
                "$ref":"#/components/schemas/hedFeeInstances-tagAssignments-item-post-request"
            }
        }
    }
}

Nested Schema : Tag Assignments

Type: array

Title: Tag Assignments

Tags provide a way to classify, group, or process fees as well as report on fee transactions.

Show Source

• Array of: object hedFeeInstances-tagAssignments-item-post-request

{
    "title":"Tag Assignments",
    "type":"array",
    "description":"Tags provide a way to classify, group, or process fees as well as report on fee transactions.",
    "items":{
        "$ref":"#/components/schemas/hedFeeInstances-tagAssignments-item-post-request"
    }
}

Nested Schema : hedFeeInstances-tagAssignments-item-post-request

Type: object

Show Source

• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  Code of a tag assigned to a fee.
• TagId: integer (int64)
  Title: Tag ID

  Unique identifier of a tag assigned to the fee.

{
    "type":"object",
    "properties":{
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of a tag assigned to a fee.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"Unique identifier of a tag assigned to the fee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.hed.campusCommunity.tags.publicModel.view.TagVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"TagName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"TagId"
            }
        }
    }
}

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 : hedFeeInstances-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active Flag

  Read Only: true

  Maximum Length: 1

  Flag to indicate if the fee is active or inactive. If yes, the fee is active, else it's inactive.
• AllowDiscountFlag: boolean
  Title: Allow Discount

  Maximum Length: 1

  Flag to indicate if discount is allowed for the fee or not. If set to yes, discount is allowed.
• CurrencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 15

  The currency code associated with the fees.
• CurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  Maximum Length: 255

  The currency symbol associated with the fees.
• DeletableFlag: boolean
  Title: Delete Flag

  Read Only: true

  Maximum Length: 1

  Flag to indicate if the fee instance can be deleted. If set to yes, delete is allowed, else it's not allowed.
• EndDate: string (date)
  Title: Instance End Date

  End date of the fee instance.
• FeeAtrrStatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 255

  Fee instance status code.
• FeeAtrrStatusMeaning: string
  Title: Status Meaning

  Read Only: true

  Maximum Length: 255

  Fee instance status meaning.
• FeeCode: string
  Title: Fee Code

  Maximum Length: 30

  Code of fee instance.
• FeeDescription: string
  Title: Description

  Maximum Length: 240

  Description of the fee.
• FeeId: integer (int64)
  Title: Fee ID

  Unique identifier of the fee.
• FeeInstanceCode: string
  Title: Instance Code

  Maximum Length: 30

  Code of the fees.
• FeeInstanceCodeLockFlag: boolean
  Title: Fee Instance Code Lock Flag

  Read Only: true

  Maximum Length: 1

  Lock flag to indicate if the instance code can be updated or not. If set to yes, it can't be updated by the user.
• FeeInstanceId: integer (int64)
  Title: Fee Attribute ID

  Read Only: true

  Unique identifier of the fee instance.
• FeeName: string
  Title: Fee Name

  Maximum Length: 50

  Name of the fee.
• FeeTypeCode: string
  Title: Fee Type Code

  Maximum Length: 30

  Code of the fee type.
• FeeTypeId: integer
  Title: Fee Type

  Unique identifier of the fee type.
• FeeTypeName: string
  Title: Fee Type Name

  Read Only: true

  Maximum Length: 50

  Name of the fee type.
• FlatAmount: number
  Title: Amount

  Default Value: 0

  The amount setup for the fee instance.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Last updated date of the fee record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StartDate: string (date)
  Title: Instance Start Date

  Start date of the fee instance.
• tagAssignments: array Tag Assignments
  Title: Tag Assignments

  Tags provide a way to classify, group, or process fees as well as report on fee transactions.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to indicate if the fee is active or inactive. If yes, the fee is active, else it's inactive.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowDiscountFlag":{
            "title":"Allow Discount",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to indicate if discount is allowed for the fee or not. If set to yes, discount is allowed.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the fees.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":255,
            "type":"string",
            "description":"The currency symbol associated with the fees.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeletableFlag":{
            "title":"Delete Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to indicate if the fee instance can be deleted. If set to yes, delete is allowed, else it's not allowed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "FeeInstanceId",
                    "FeeId"
                ]
            }
        },
        "EndDate":{
            "title":"Instance End Date",
            "type":"string",
            "description":"End date of the fee instance.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FeeAtrrStatusCode":{
            "title":"Status Code",
            "maxLength":255,
            "type":"string",
            "description":"Fee instance status code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeAtrrStatusMeaning":{
            "title":"Status Meaning",
            "maxLength":255,
            "type":"string",
            "description":"Fee instance status meaning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeCode":{
            "title":"Fee Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of fee instance.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "FeeId"
                ]
            },
            "x-queryable":true
        },
        "FeeDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the fee.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeId":{
            "title":"Fee ID",
            "type":"integer",
            "description":"Unique identifier of the fee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeeInstanceCode":{
            "title":"Instance Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the fees.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FeeInstanceCodeLockFlag":{
            "title":"Fee Instance Code Lock Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Lock flag to indicate if the instance code can be updated or not. If set to yes, it can't be updated by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeInstanceId":{
            "title":"Fee Attribute ID",
            "type":"integer",
            "description":"Unique identifier of the fee instance.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FeeName":{
            "title":"Fee Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the fee.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FeeTypeCode":{
            "title":"Fee Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the fee type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FeeTypeId":{
            "title":"Fee Type",
            "type":"integer",
            "description":"Unique identifier of the fee type.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "FeeTypeCode"
                ]
            },
            "x-queryable":true
        },
        "FeeTypeName":{
            "title":"Fee Type Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the fee type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FlatAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount setup for the fee instance.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Last updated date of the fee record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Instance Start Date",
            "type":"string",
            "description":"Start date of the fee instance.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "tagAssignments":{
            "title":"Tag Assignments",
            "type":"array",
            "description":"Tags provide a way to classify, group, or process fees as well as report on fee transactions.",
            "items":{
                "$ref":"#/components/schemas/hedFeeInstances-tagAssignments-item-response"
            }
        }
    }
}

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 : Tag Assignments

Type: array

Title: Tag Assignments

Tags provide a way to classify, group, or process fees as well as report on fee transactions.

Show Source

• Array of: object hedFeeInstances-tagAssignments-item-response

{
    "title":"Tag Assignments",
    "type":"array",
    "description":"Tags provide a way to classify, group, or process fees as well as report on fee transactions.",
    "items":{
        "$ref":"#/components/schemas/hedFeeInstances-tagAssignments-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 : hedFeeInstances-tagAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  Read Only: true

  Unique identifier of the assignment of a tag to the fee.
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  Code of a tag assigned to a fee.
• TagId: integer (int64)
  Title: Tag ID

  Unique identifier of a tag assigned to the fee.
• TagName: string
  Title: Tag Name

  Read Only: true

  Maximum Length: 64

  Name of a tag assigned to a fee.

{
    "type":"object",
    "properties":{
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the assignment of a tag to the fee.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of a tag assigned to a fee.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"Unique identifier of a tag assigned to the fee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.hed.campusCommunity.tags.publicModel.view.TagVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"TagName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"TagId"
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"Name of a tag assigned to a 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"
            }
        }
    }
}

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

feeTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/feeTypesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: FeeTypeCode; Target Attribute: FeeTypeCode
• Display Attribute: FeeTypeName

tagAssignments

Operation: /fscmRestApi/resources/11.13.18.05/hedFeeInstances/{FeeInstanceId}/child/tagAssignments

Parameters:

• FeeInstanceId: $request.path.FeeInstanceId

Tags provide a way to classify, group, or process fees as well as report on fee transactions.

Back to Top