Jump to

• Request
• Response

Update a fee mapping detail

patch

/fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeMappingDetails/{FeeMappingDetailId}

Request

Path Parameters

• ChargePriorityId(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=
• FeeMappingDetailId(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

• FeeCode: string
  Title: Fee Code

  Maximum Length: 30

  Unique user-defined fee code.
• FeeId: integer (int64)
  Title: Fee ID

  Unique identifier of the fee.
• MappingAttributeCode: string
  Title: Mapping Attribute Code

  Maximum Length: 30

  Unique user-defined fee mapping attribute code.
• MappingAttributeId: integer (int64)
  Title: Mapping Attribute ID

  Unique identifier of the fee mapping attribute.
• Priority: integer (int64)
  Title: Priority

  Priority of the fee in the mapping.

{
    "type":"object",
    "properties":{
        "FeeId":{
            "title":"Fee ID",
            "type":"integer",
            "description":"Unique identifier of the fee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "FeeCode"
                ]
            }
        },
        "MappingAttributeCode":{
            "title":"Mapping Attribute Code",
            "maxLength":"30",
            "type":"string",
            "description":"Unique user-defined fee mapping attribute code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BusinessUnitName"
                ]
            }
        },
        "MappingAttributeId":{
            "title":"Mapping Attribute ID",
            "type":"integer",
            "description":"Unique identifier of the fee mapping attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "MappingAttributeCode"
                ]
            }
        },
        "Priority":{
            "title":"Priority",
            "type":"integer",
            "description":"Priority of the fee in the mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "FeeCode":{
            "title":"Fee Code",
            "maxLength":"30",
            "type":"string",
            "description":"Unique user-defined fee code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BusinessUnitName"
                ]
            }
        }
    }
}

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 : chargePriorityMappings-feeMappingDetails-item-response

Type: object

Show Source

• FeeCode: string
  Title: Fee Code

  Maximum Length: 30

  Unique user-defined fee code.
• FeeId: integer (int64)
  Title: Fee ID

  Unique identifier of the fee.
• FeeMappingDetailId: integer (int64)
  Title: Fee Mapping ID

  Read Only: true

  Unique identifier of the fee associated to the charge priority.
• FeeName: string
  Title: Fee Name

  Read Only: true

  Maximum Length: 50

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

  Read Only: true

  Maximum Length: 30

  Unique user-defined code of the fee type.
• FeeTypeName: string
  Title: Fee Type Name

  Read Only: true

  Maximum Length: 50

  Name of the fee type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingAttributeCode: string
  Title: Mapping Attribute Code

  Maximum Length: 30

  Unique user-defined fee mapping attribute code.
• MappingAttributeId: integer (int64)
  Title: Mapping Attribute ID

  Unique identifier of the fee mapping attribute.
• MappingAttributeName: string
  Title: Mapping Attribute Name

  Read Only: true

  Maximum Length: 50

  Name of the fee mapping attribute.
• Priority: integer (int64)
  Title: Priority

  Priority of the fee in the mapping.

{
    "type":"object",
    "properties":{
        "FeeName":{
            "title":"Fee Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the fee.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "MappingAttributeId":{
            "title":"Mapping Attribute ID",
            "type":"integer",
            "description":"Unique identifier of the fee mapping attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "MappingAttributeCode"
                ]
            },
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "type":"integer",
            "description":"Priority of the fee in the mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FeeMappingDetailId":{
            "title":"Fee Mapping ID",
            "type":"integer",
            "description":"Unique identifier of the fee associated to the charge priority.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FeeTypeCode":{
            "title":"Fee Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Unique user-defined code of the fee type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeId":{
            "title":"Fee ID",
            "type":"integer",
            "description":"Unique identifier of the fee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "FeeCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MappingAttributeCode":{
            "title":"Mapping Attribute Code",
            "maxLength":"30",
            "type":"string",
            "description":"Unique user-defined fee mapping attribute code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BusinessUnitName"
                ]
            },
            "x-queryable":true
        },
        "MappingAttributeName":{
            "title":"Mapping Attribute Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the fee mapping attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeCode":{
            "title":"Fee Code",
            "maxLength":"30",
            "type":"string",
            "description":"Unique user-defined fee code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BusinessUnitName"
                ]
            },
            "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 : 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."
        }
    }
}

Links

feesLOV

Operation: /fscmRestApi/resources/11.13.18.05/feesLOV

Parameters:

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

The following properties are defined on the LOV link relation:

• Source Attribute: FeeCode; Target Attribute: FeeCode
• Display Attribute: FeeName

financialMappingAttributesLOV

Operation: /fscmRestApi/resources/11.13.18.05/financialMappingAttributesLOV

Parameters:

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

The following properties are defined on the LOV link relation:

• Source Attribute: MappingAttributeCode; Target Attribute: MappingAttributeCode
• Display Attribute: MappingAttributeName

Back to Top