Create a fee list structure
post
/fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures
Request
Path Parameters
-
FeeGroupId(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.
-
Upsert-Mode:
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
Root Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:1000
Description of the fee group structure. -
Name(required): string
Title:
Name
Maximum Length:50
Name of the fee group structure. -
ParentFeeGroupStructureId: integer
Title:
Parent Fee Item ID
Parent fee of a fee in a fee group. -
Sequence(required): integer
Title:
Fee List Sequence
Sequence number of the fee group structure. -
structureDetails: array
Structure Details
Title:
Structure Details
Details about the fee group structure, such as name and description.
Nested Schema : Structure Details
Type:
array
Title:
Structure Details
Details about the fee group structure, such as name and description.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
Sequence: integer
Title:
Structure Detail Sequence
Sequence number of the fee item within a fee group. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:30
Code of the source object. -
SourceObjectId: integer
Title:
Source Object ID
Unique identifier of the source object detail.
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.
Root Schema : feeGroups-feeGroupStructures-item-response
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:1000
Description of the fee group structure. -
FeeGroupStructureId: integer
Title:
Fee List Structure ID
Read Only:true
Unique identifier of the fee group structure. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:50
Name of the fee group structure. -
ParentFeeGroupStructureId: integer
Title:
Parent Fee Item ID
Parent fee of a fee in a fee group. -
Sequence: integer
Title:
Fee List Sequence
Sequence number of the fee group structure. -
structureDetails: array
Structure Details
Title:
Structure Details
Details about the fee group structure, such as name and description.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Structure Details
Type:
array
Title:
Structure Details
Details about the fee group structure, such as name and description.
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 : feeGroups-feeGroupStructures-structureDetails-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Sequence: integer
Title:
Structure Detail Sequence
Sequence number of the fee item within a fee group. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:30
Code of the source object. -
SourceObjectId: integer
Title:
Source Object ID
Unique identifier of the source object detail. -
SourceObjectMeaning: string
Title:
Source Object Meaning
Read Only:true
Maximum Length:80
Meaning of the source object. -
StructureDetailId: integer
Title:
Fee Structure Detail ID
Read Only:true
Unique identifier of the fee group structure detail.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- structureDetails
-
Parameters:
- FeeGroupId:
$request.path.FeeGroupId
- FeeGroupStructureId:
$request.path.FeeGroupStructureId
Details about the fee group structure, such as name and description. - FeeGroupId: