Jump to

• Request
• Response

Get a discount

get

/fscmRestApi/resources/11.13.18.05/feeDiscounts/{DiscountId}

Request

Path Parameters

• DiscountId(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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active Flag

  Maximum Length: 1

  Default Value: true

  This indicates whether the discount is active or not. The default value is true.
• AllowOverrideFlag: boolean
  Title: Allow override

  Maximum Length: 1

  This indicates whether you can override a discount. The default value is true.
• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  Unique identifier of the business unit associated to the discount.
• BusinessUnitName: string
  Title: Business Unit Name

  Name of the business unit.
• DeleteAllowedFlag: boolean
  Title: Delete Flag

  Read Only: true

  Maximum Length: 1

  Indicates if the discount has been applied to existing invoices.
• DiscountDescription: string
  Title: Discount Description

  Maximum Length: 240

  The description of the discount.
• DiscountId: integer (int64)
  Title: Discount ID

  Read Only: true

  The unique identifier of the discount.
• DiscountName: string
  Title: Discount Name

  Maximum Length: 50

  The unique name of the discount.
• DiscountPercent: number
  Title: Discount Percentage

  The discount percentage associated to a discount.
• DiscountPriority: integer (int32)
  Title: Priority

  The priority associated to a discount.
• DiscountTypeCode: string
  Title: Discount Type Code

  Maximum Length: 30

  Code of the discount.This code could be manual, automatic, or promotion code type.
• DiscountTypeMeaning: string
  Title: Discount Type Meaning

  Maximum Length: 80

  Meaning of the code.
• EndDate: string (date)
  Title: End Date

  The end date of the discount.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemoLineId: integer (int64)
  Title: Memo Line ID

  Unique identifier of the memo line associated to the discount.
• MemoLineName: string
  Title: Memo Line Name

  Name of the memo line.
• PromotionCode: string
  Title: Promotion Code

  Maximum Length: 50

  The unique code to identify the promotion for the discount.
• RuleId: integer (int64)
  Unique identifier of the rule associated to the discount.
• StartDate: string (date)
  Title: Start Date

  The start date of the discount.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"This indicates whether the discount is active or not. The default value is true.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "AllowOverrideFlag":{
            "title":"Allow override",
            "maxLength":1,
            "type":"boolean",
            "description":"This indicates whether you can override a discount. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Unique identifier of the business unit associated to the discount.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeleteAllowedFlag":{
            "title":"Delete Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the discount has been applied to existing invoices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DiscountDescription":{
            "title":"Discount Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the discount.",
            "nullable":true,
            "x-queryable":true
        },
        "DiscountId":{
            "title":"Discount ID",
            "type":"integer",
            "description":"The unique identifier of the discount.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DiscountName":{
            "title":"Discount Name",
            "maxLength":50,
            "type":"string",
            "description":"The unique name of the discount.",
            "nullable":false,
            "x-queryable":true
        },
        "DiscountPercent":{
            "title":"Discount Percentage",
            "type":"number",
            "description":"The discount percentage associated to a discount.",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "DiscountPriority":{
            "title":"Priority",
            "type":"integer",
            "description":"The priority associated to a discount.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "DiscountTypeCode":{
            "title":"Discount Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the discount.This code could be manual, automatic, or promotion code type.",
            "nullable":false,
            "x-queryable":true
        },
        "DiscountTypeMeaning":{
            "title":"Discount Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the code.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the discount.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "MemoLineId":{
            "title":"Memo Line ID",
            "type":"integer",
            "description":"Unique identifier of the memo line associated to the discount.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "type":"string",
            "description":"Name of the memo line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PromotionCode":{
            "title":"Promotion Code",
            "maxLength":50,
            "type":"string",
            "description":"The unique code to identify the promotion for the discount.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"Unique identifier of the rule associated to the discount.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the discount.",
            "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"
            }
        }
    }
}

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

genericLookupsLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HES_DISCOUNT_TYPE_CODES

The following properties are defined on the LOV link relation:

• Source Attribute: DiscountTypeMeaning; Target Attribute: Meaning
• Display Attribute: Meaning

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

Back to Top