Jump to

• Request
• Response

Get an earning

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedEarningsPerInterval/{incentiveCompensationSummarizedEarningsPerIntervalUniqID}

Request

Path Parameters

• incentiveCompensationSummarizedEarningsPerIntervalUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ParticipantId, IntervalName, IntervalNumber and OrgId ---for the Incentive Compensation Summarized Earnings Per Intervals resource and used to uniquely identify an instance of Incentive Compensation Summarized Earnings Per Intervals. The client should not generate the hash key value. Instead, the client should query on the Incentive Compensation Summarized Earnings Per Intervals collection resource with a filter on the primary key values in order to navigate to a specific instance of Incentive Compensation Summarized Earnings Per Intervals.
  
  For example: incentiveCompensationSummarizedEarningsPerInterval?q=ParticipantId=<value1>;IntervalName=<value2>;IntervalNumber=<value3>;OrgId=<value4>

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:
  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.

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

Type: object

Show Source

• CurrencyCode: string
  Read Only: true

  Maximum Length: 30

  The code indicating the processing currency for the earnings amount.
• IntervalEndDate: string (date)
  Read Only: true

  The end date of the interval selected under calendar period type.
• IntervalName: string
  Read Only: true

  Maximum Length: 80

  The interval name representing the calendar period type you define under Calendar and Currency Parameters for the specific BU using the Setup and Maintenance work area, Manage Parameters task. For example, Calendar Period Type is set to Monthly for US Business Unit.
• IntervalNumber: string
  Read Only: true

  Maximum Length: 50

  The interval number used to assign periods to interval types by providing the same interval numbers to each.
• IntervalStartDate: string (date)
  Read Only: true

  The start date of the interval selected under calendar period type.
• links: array Links
  Title: Links

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

  The unique identifier of the business unit associated with the participant.
• ParticipantId: integer (int64)
  Read Only: true

  The unique identifier of the incentive compensation participant.
• ParticipantName: string
  Read Only: true

  Maximum Length: 360

  The name of the participant.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier of the party.
• SourceSystemId: string
  Read Only: true

  Maximum Length: 60

  The unique identifier of the source system.
• TotalEarningAmountPTD: number
  Read Only: true

  The sum of the earnings amount in functional currency within the interval selected under calendar period type.

{
    "type":"object",
    "properties":{
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the incentive compensation participant.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the processing currency for the earnings amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalEarningAmountPTD":{
            "type":"number",
            "description":"The sum of the earnings amount in functional currency within the interval selected under calendar period type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the participant.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IntervalStartDate":{
            "type":"string",
            "description":"The start date of the interval selected under calendar period type.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalEndDate":{
            "type":"string",
            "description":"The end date of the interval selected under calendar period type.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IntervalName":{
            "maxLength":"80",
            "type":"string",
            "description":"The interval name representing the calendar period type you define under Calendar and Currency Parameters for the specific BU using the Setup and Maintenance work area, Manage Parameters task. For example, Calendar Period Type is set to Monthly for US Business Unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantName":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"The interval number used to assign periods to interval types by providing the same interval numbers to each.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystemId":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the source system.",
            "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 : 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