Jump to

• Request
• Response

Update a fee instance

patch

/fscmRestApi/resources/11.13.18.05/hedFeeInstances/{FeeInstanceId}

Request

Path Parameters

• FeeInstanceId(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

• ActiveFlag: boolean
  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
  Maximum Length: 1

  Flag to indicate if discount is allowed for the fee or not. If set to yes, discount is allowed.
• BatchSourceSequenceId: integer (int64)
  Unique identifier of the batch transaction source setup on the fee instance.
• BusinessUnitId: integer
  Unique identifier of the business unit.
• CreditTransactionTypeId: integer (int64)
  Unique identifier of the credit transaction type setup on the fee instance.
• CreditTransactionTypeName: string
  Title: Transaction Type Name

  Maximum Length: 20

  Name of the credit transaction type setup on the fee instance.
• CurrencyCode: string
  Maximum Length: 15

  The currency code associated with the fees.
• EndDate: string (date)
  End date of the fee instance.
• FeeCode: string
  Maximum Length: 30

  Description of the fee.
• FeeDescription: string
  Maximum Length: 240

  Unique identifier of the fee.
• FeeInstanceCode: string
  Maximum Length: 150

  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.
• FeeName: string
  Maximum Length: 50

  Name of the fee.
• FeeTypeCode: string
  Maximum Length: 255

  Code of the fee type.
• FeeTypeId: integer
  Unique identifier of the fee type.
• FlatAmount: number
  Default Value: 0

  The amount setup for the fee instance.
• InheritOptionFlag: boolean
  Maximum Length: 1

  Default Value: false

  Unique identifier of the transaction source setup on the fee instance.
• MemoLineId: integer (int64)
  Unique identifier of the memo line setup on the fee instance.
• MemoLineName: string
  Title: Memo Line Name

  Maximum Length: 50

  Name of the memo line setup on the fee instance.
• StartDate: string (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.
• TransactionTypeId: integer (int64)
  Unique identifier of the transaction type setup on the fee instance.
• TransactionTypeName: string
  Title: Transaction Type Name

  Maximum Length: 20

  Name of the transaction type setup on the fee instance.

{
    "type":"object",
    "properties":{
        "TransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":"20",
            "type":"string",
            "description":"Name of the transaction type setup on the fee instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "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-patch-request"
            }
        },
        "AllowDiscountFlag":{
            "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
        },
        "FlatAmount":{
            "type":"number",
            "description":"The amount setup for the fee instance.",
            "nullable":true,
            "default":"0"
        },
        "BatchSourceSequenceId":{
            "type":"integer",
            "description":"Unique identifier of the batch transaction source setup on the fee instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "BatchSourceSequenceName"
                ]
            }
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Unique identifier of the business unit.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "BusinessUnitName"
                ]
            }
        },
        "FeeTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Code of the fee type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionTypeId":{
            "type":"integer",
            "description":"Unique identifier of the transaction type setup on the fee instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreditTransactionTypeId":{
            "type":"integer",
            "description":"Unique identifier of the credit transaction type setup on the fee instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "FeeTypeId":{
            "type":"integer",
            "description":"Unique identifier of the fee type.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "FeeTypeCode"
                ]
            }
        },
        "ActiveFlag":{
            "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
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the fee instance.",
            "format":"date",
            "nullable":true
        },
        "FeeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Description of the fee.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "FeeId"
                ]
            }
        },
        "FeeName":{
            "maxLength":"50",
            "type":"string",
            "description":"Name of the fee.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the fee instance.",
            "format":"date",
            "nullable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the fees.",
            "nullable":true
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the memo line setup on the fee instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CreditTransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":"20",
            "type":"string",
            "description":"Name of the credit transaction type setup on the fee instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "FeeInstanceCode":{
            "maxLength":"150",
            "type":"string",
            "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
        },
        "FeeDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Unique identifier of the fee.",
            "nullable":false
        },
        "InheritOptionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Unique identifier of the transaction source setup on the fee instance.",
            "nullable":true,
            "default":false
        },
        "MemoLineId":{
            "type":"integer",
            "description":"Unique identifier of the memo line setup on the fee instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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-patch-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-patch-request"
    }
}

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

Type: object

Show Source

• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  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.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"Unique identifier of a tag assigned to the fee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the assignment of a tag to the fee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of a tag assigned to a fee.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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
  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
  Maximum Length: 1

  Flag to indicate if discount is allowed for the fee or not. If set to yes, discount is allowed.
• BatchSourceSequenceId: integer (int64)
  Unique identifier of the batch transaction source setup on the fee instance.
• BatchSourceSequenceName: string
  Read Only: true

  Maximum Length: 255

  Name of the batch transaction source setup on the fee instance.
• BusinessUnitActiveFlag: boolean
  Read Only: true

  Maximum Length: 1

  Flag to indicate if the business unit is active.
• BusinessUnitDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the business unit.
• BusinessUnitId: integer
  Unique identifier of the business unit.
• BusinessUnitName: string
  Read Only: true

  Maximum Length: 255

  Name of the business unit.
• CreditTransactionTypeId: integer (int64)
  Unique identifier of the credit transaction type setup on the fee instance.
• CreditTransactionTypeName: string
  Title: Transaction Type Name

  Maximum Length: 20

  Name of the credit transaction type setup on the fee instance.
• CurrencyCode: string
  Maximum Length: 15

  The currency code associated with the fees.
• CurrencySymbol: string
  Read Only: true

  Maximum Length: 255

  The currency symbol associated with the fees.
• DeletableFlag: boolean
  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)
  End date of the fee instance.
• FeeAtrrStatusCode: string
  Read Only: true

  Maximum Length: 255

  Fee instance status code.
• FeeAtrrStatusMeaning: string
  Read Only: true

  Maximum Length: 255

  Fee instance status meaning.
• FeeCode: string
  Maximum Length: 30

  Description of the fee.
• FeeDescription: string
  Maximum Length: 240

  Unique identifier of the fee.
• FeeId: integer (int64)
  Code of fee instance.
• FeeInstanceCode: string
  Maximum Length: 150

  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.
• FeeInstanceCodeLockFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: false

  Code of the fees.
• FeeInstanceId: integer (int64)
  Read Only: true

  Unique identifier of the fee instance.
• FeeName: string
  Maximum Length: 50

  Name of the fee.
• FeeTypeCode: string
  Maximum Length: 255

  Code of the fee type.
• FeeTypeId: integer
  Unique identifier of the fee type.
• FeeTypeName: string
  Read Only: true

  Maximum Length: 255

  Name of the fee type.
• FlatAmount: number
  Default Value: 0

  The amount setup for the fee instance.
• InheritedBatchSourceSequenceId: integer
  Read Only: true

  Name of the transaction source setup on the fee instance.
• InheritedBatchSourceSequenceName: string
  Read Only: true

  Maximum Length: 255

  Unique identifier of the credit transaction type setup on the business unit from which the fee instance is inheriting the values.
• InheritedCreditTransactionTypeId: integer
  Read Only: true

  Name of the credit transaction type setup on the business unit from which the fee instance is inheriting the values.
• InheritedCreditTransactionTypeName: string
  Read Only: true

  Maximum Length: 255

  Unique identifier of the memo line setup on the business unit from which the fee instance is inheriting the values.
• InheritedMemoLineId: integer
  Read Only: true

  Name of the memo line setup on the business unit from which the fee instance is inheriting the values.
• InheritedMemoLineName: string
  Read Only: true

  Maximum Length: 255

  Unique identifier of the transaction source setup on the business unit from which the fee instance is inheriting the values.
• InheritedTransactionTypeId: integer
  Read Only: true

  Name of the transaction type setup on the business unit from which the fee instance is inheriting the values.
• InheritedTransactionTypeName: string
  Read Only: true

  Maximum Length: 255

  Flag to indicate if the accounts receivable attributes for the fees should be inherited from the business unit setup or not.
• InheritOptionFlag: boolean
  Maximum Length: 1

  Default Value: false

  Unique identifier of the transaction source setup on the fee instance.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  The link relations associated with the resource instance.
• MemoLineId: integer (int64)
  Unique identifier of the memo line setup on the fee instance.
• MemoLineName: string
  Title: Memo Line Name

  Maximum Length: 50

  Name of the memo line setup on the fee instance.
• StartDate: string (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.
• TransactionTypeId: integer (int64)
  Unique identifier of the transaction type setup on the fee instance.
• TransactionTypeName: string
  Title: Transaction Type Name

  Maximum Length: 20

  Name of the transaction type setup on the fee instance.

{
    "type":"object",
    "properties":{
        "TransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":"20",
            "type":"string",
            "description":"Name of the transaction type setup on the fee instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "AllowDiscountFlag":{
            "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
        },
        "BusinessUnitDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritedTransactionTypeId":{
            "type":"integer",
            "description":"Name of the transaction type setup on the business unit from which the fee instance is inheriting the values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchSourceSequenceId":{
            "type":"integer",
            "description":"Unique identifier of the batch transaction source setup on the fee instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "BatchSourceSequenceName"
                ]
            },
            "x-queryable":true
        },
        "FeeAtrrStatusMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Fee instance status meaning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Code of the fee type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionTypeId":{
            "type":"integer",
            "description":"Unique identifier of the transaction type setup on the fee instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeletableFlag":{
            "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"
                ]
            }
        },
        "CurrencySymbol":{
            "maxLength":"255",
            "type":"string",
            "description":"The currency symbol associated with the fees.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Description of the fee.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "FeeId"
                ]
            },
            "x-queryable":true
        },
        "FeeName":{
            "maxLength":"50",
            "type":"string",
            "description":"Name of the fee.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the fee instance.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the fees.",
            "nullable":true,
            "x-queryable":true
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the memo line setup on the fee instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InheritedBatchSourceSequenceName":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of the credit transaction type setup on the business unit from which the fee instance is inheriting the values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeInstanceCode":{
            "maxLength":"150",
            "type":"string",
            "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,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FeeAtrrStatusCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Fee instance status code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritedMemoLineName":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of the transaction source setup on the business unit from which the fee instance is inheriting the values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemoLineId":{
            "type":"integer",
            "description":"Unique identifier of the memo line setup on the fee instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FeeTypeName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the fee type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritedMemoLineId":{
            "type":"integer",
            "description":"Name of the memo line setup on the business unit from which the fee instance is inheriting the values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlatAmount":{
            "type":"number",
            "description":"The amount setup for the fee instance.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "BusinessUnitActiveFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Flag to indicate if the business unit is active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Unique identifier of the business unit.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "BusinessUnitName"
                ]
            },
            "x-queryable":true
        },
        "FeeId":{
            "type":"integer",
            "description":"Code of fee instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BatchSourceSequenceName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the batch transaction source setup on the fee instance.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreditTransactionTypeId":{
            "type":"integer",
            "description":"Unique identifier of the credit transaction type setup on the fee instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FeeInstanceId":{
            "type":"integer",
            "description":"Unique identifier of the fee instance.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FeeTypeId":{
            "type":"integer",
            "description":"Unique identifier of the fee type.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "FeeTypeCode"
                ]
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "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,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the fee instance.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreditTransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":"20",
            "type":"string",
            "description":"Name of the credit transaction type setup on the fee instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InheritedTransactionTypeName":{
            "maxLength":"255",
            "type":"string",
            "description":"Flag to indicate if the accounts receivable attributes for the fees should be inherited from the business unit setup or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeInstanceCodeLockFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Code of the fees.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "FeeDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Unique identifier of the fee.",
            "nullable":false,
            "x-queryable":true
        },
        "InheritedCreditTransactionTypeName":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of the memo line setup on the business unit from which the fee instance is inheriting the values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritedCreditTransactionTypeId":{
            "type":"integer",
            "description":"Name of the credit transaction type setup on the business unit from which the fee instance is inheriting the values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritOptionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Unique identifier of the transaction source setup on the fee instance.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last updated date of the fee record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritedBatchSourceSequenceId":{
            "type":"integer",
            "description":"Name of the transaction source setup on the fee instance.",
            "nullable":true,
            "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 : 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

  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":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"Unique identifier of a tag assigned to the fee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the assignment of a tag to the fee.",
            "format":"int64",
            "nullable":false,
            "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
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":"64",
            "type":"string",
            "description":"Name of a tag assigned to a fee.",
            "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"
    }
}

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

hedTransactionSourcesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedTransactionSourcesLOV

Parameters:

• finder: FindByBusinessUnit%3BBusinessUnitId%3D{BusinessUnitId}

The following properties are defined on the LOV link relation:

• Source Attribute: BatchSourceSequenceName; Target Attribute: BatchSourceName
• Display Attribute: BatchSourceName

studentFinancialSystemConfigurationsLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurationsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: BusinessUnitName; Target Attribute: Name
• Display Attribute: Name

studentMemoLinesLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentMemoLinesLOV

Parameters:

• finder: ByBusinessUnitFinder

The following properties are defined on the LOV link relation:

• Source Attribute: MemoLineName; Target Attribute: MemoLineName
• Display Attribute: MemoLineName

studentTransactionTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentTransactionTypesLOV

Parameters:

• finder: InvoiceTransactionTypeFinder%3BBusinessUnitName%3D{BusinessUnitName}

The following properties are defined on the LOV link relation:

• Source Attribute: TransactionTypeName; Target Attribute: TransactionTypeName
• Display Attribute: TransactionTypeName

studentTransactionTypesLOV1

Operation: /fscmRestApi/resources/11.13.18.05/studentTransactionTypesLOV

Parameters:

• finder: CreditMemoTransactionTypeFinder%3BBusinessUnitName%3D{BusinessUnitName}

The following properties are defined on the LOV link relation:

• Source Attribute: CreditTransactionTypeName; Target Attribute: TransactionTypeName
• Display Attribute: TransactionTypeName

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