Jump to

• Request
• Response

Update one transfer charge rule detail

patch

/fscmRestApi/resources/11.13.18.05/transferChargeRules/{TransferChargeRuleId}/child/ruleDetails/{TransferChargeRuleDetailId}

Request

Path Parameters

• TransferChargeRuleDetailId(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=
• TransferChargeRuleId(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

• CostElement: string
  Title: Cost Element

  Maximum Length: 30

  Cost element to use when creating an transfer charge rule detail.
• CostElementId: integer (int64)
  Value that uniquely identifies the cost element.
• ExpensePoolCode: string
  Title: Expense Pool

  Maximum Length: 30

  Expense pool to be used in the transfer charge rule detail.
• ExpensePoolId: integer (int64)
  Value that uniquely identifies the expense pool.
• TransferChargeRuleId: integer (int64)
  Value that uniquely identifies the transfer charge rule header for the transfer rule detail.
• TransferChargeTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the transfer charge value type. Values include PERCENT.
• TransferChargeValue: number
  Title: Rate

  Value for the transfer charge rule rollup.

{
    "type":"object",
    "properties":{
        "ExpensePoolCode":{
            "title":"Expense Pool",
            "maxLength":30,
            "type":"string",
            "description":"Expense pool to be used in the transfer charge rule detail.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostElementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cost element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExpensePoolId":{
            "type":"integer",
            "description":"Value that uniquely identifies the expense pool.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TransferChargeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the transfer charge value type. Values include PERCENT.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransferChargeRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer charge rule header for the transfer rule detail.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CostElement":{
            "title":"Cost Element",
            "maxLength":30,
            "type":"string",
            "description":"Cost element to use when creating an transfer charge rule detail.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransferChargeValue":{
            "title":"Rate",
            "type":"number",
            "description":"Value for the transfer charge rule rollup.",
            "nullable":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(required):
  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(required):
  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 : transferChargeRules-ruleDetails-item-response

Type: object

Show Source

• CostElement: string
  Title: Cost Element

  Maximum Length: 30

  Cost element to use when creating an transfer charge rule detail.
• CostElementId: integer (int64)
  Value that uniquely identifies the cost element.
• CostElementType: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the cost element type of the cost element used in the transfer charge rule.
• CostElementTypeCode: string
  Title: Cost Element Type

  Read Only: true

  Maximum Length: 30

  Value that identifies the cost element type of the cost element used in the transfer charge rule.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Name of the user who created the transfer charge rule detail.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date on which the transfer charge rule detail was created.
• ExpensePoolCode: string
  Title: Expense Pool

  Maximum Length: 30

  Expense pool to be used in the transfer charge rule detail.
• ExpensePoolId: integer (int64)
  Value that uniquely identifies the expense pool.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date on which the transfer charge rule detail was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the transfer charge rule detail.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TransferChargeRuleDetailId: integer (int64)
  Read Only: true

  Value that uniquely identifies the transfer charge rule detail. The application generates this value.
• TransferChargeRuleId: integer (int64)
  Value that uniquely identifies the transfer charge rule header for the transfer rule detail.
• TransferChargeType: string
  Title: Charge Type

  Read Only: true

  Maximum Length: 80

  Meaning that identifies the transfer charge value type.
• TransferChargeTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the transfer charge value type. Values include PERCENT.
• TransferChargeValue: number
  Title: Rate

  Value for the transfer charge rule rollup.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the transfer charge rule detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the transfer charge rule detail was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostElementTypeCode":{
            "title":"Cost Element Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the cost element type of the cost element used in the transfer charge rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the transfer charge rule detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferChargeRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer charge rule header for the transfer rule detail.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostElementType":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the cost element type of the cost element used in the transfer charge rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferChargeRuleDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer charge rule detail. The application generates this value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ExpensePoolCode":{
            "title":"Expense Pool",
            "maxLength":30,
            "type":"string",
            "description":"Expense pool to be used in the transfer charge rule detail.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostElementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cost element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransferChargeType":{
            "title":"Charge Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning that identifies the transfer charge value type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpensePoolId":{
            "type":"integer",
            "description":"Value that uniquely identifies the expense pool.",
            "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"
            }
        },
        "TransferChargeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the transfer charge value type. Values include PERCENT.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostElement":{
            "title":"Cost Element",
            "maxLength":30,
            "type":"string",
            "description":"Cost element to use when creating an transfer charge rule detail.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransferChargeValue":{
            "title":"Rate",
            "type":"number",
            "description":"Value for the transfer charge rule rollup.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date on which the transfer charge rule detail 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 : 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."
        }
    }
}

Back to Top