Jump to

• Request
• Response

Get a single credit detail

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipantCreditDetails/{CreditId}

Request

Path Parameters

• CreditId(required): integer
  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 : incentiveCompensationParticipantCreditDetails-item-response

Type: object

Show Source

• BookedDate: string (date)
  Read Only: true

  The date order gets booked.
• CategoryName: string
  Read Only: true

  Maximum Length: 160

  The name of associated credit categories.
• CreatedDuring: string
  Read Only: true

  Maximum Length: 30

  The process in which the credit was created.
• CreditAmount: number
  Read Only: true

  The credit amount in functional currency.
• CreditDate: string (date)
  Read Only: true

  The date based on which the crediting rule is determined.
• CreditId: integer
  Read Only: true

  The unique identifier assigned to the credit.
• CreditType: string
  Read Only: true

  Maximum Length: 30

  The possible values are direct, indirect, and summarized.
• CustomerId: number
  Read Only: true

  The unique identifier for the customer.
• EligibleCatId: integer (int64)
  Read Only: true

  The eligible category populated during classification.
• EmailAddress: string
  Read Only: true

  Maximum Length: 320

  Email address of the participant.
• FunctionalCurrency: string
  Read Only: true

  Maximum Length: 10

  The code indicating the processing currency for the credit amount.
• IntervalNumber: string
  Read Only: true

  Maximum Length: 50

  The interval number.
• IntervalTypeId: integer (int64)
  Read Only: true

  The unique identifier of the interval type.
• InventoryItemId: number
  Read Only: true

  The unique identifier for the item.
• InvoiceDate: string (date)
  Read Only: true

  The invoice date.
• InvoiceNumber: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the invoice.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderNumber: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the order.
• OrgId: integer (int64)
  Read Only: true

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

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

  Maximum Length: 360

  The name of the participant with whom the earnings are associated.
• PartyId: integer (int64)
  Read Only: true

  The party identifier.
• PeriodEndDate: string (date)
  Read Only: true

  The end date of the period.
• PeriodName: string
  Read Only: true

  Maximum Length: 30

  The name of the period.
• PeriodNumber: integer (int64)
  Read Only: true

  The period number.
• PeriodStartDate: string (date)
  Read Only: true

  The start date of the period.
• PeriodYear: integer (int64)
  Read Only: true

  The year associated with the period.
• RevenueType: string
  Read Only: true

  Maximum Length: 30

  The possible values are revenue, nonrevenue, and custom revenue type.
• SourceEventDate: string (date)
  Read Only: true

  The date on which the transaction was processed in the source system.
• SourceEventPeriodId: integer (int64)
  Read Only: true

  The period ID of the source event date.
• SourceParticipantId: integer (int64)
  Read Only: true

  The participant identifier on the source transaction associated with the credit.
• SourceSystemId: string
  Read Only: true

  Maximum Length: 60

  The primary key of the record in the source system.
• SourceTrxNumber: string
  Read Only: true

  Maximum Length: 30

  The user-friendly unique identifier of the transaction.
• TransactionAmount: number
  Read Only: true

  The transaction amount in functional currency.
• TransactionId: integer (int64)
  Read Only: true

  Generated from sequence.
• TransactionQuantity: number
  Read Only: true

  The transaction quantity.
• TransactionType: string
  Read Only: true

  Maximum Length: 30

  The transaction type attribute identifying the source of the transaction.
• WorkerNumber: string
  Read Only: true

  Maximum Length: 30

  The worker number of the credited participant.

{
    "type":"object",
    "properties":{
        "BookedDate":{
            "type":"string",
            "description":"The date order gets booked.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":160,
            "type":"string",
            "description":"The name of associated credit categories.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedDuring":{
            "maxLength":30,
            "type":"string",
            "description":"The process in which the credit was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditAmount":{
            "type":"number",
            "description":"The credit amount in functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditDate":{
            "type":"string",
            "description":"The date based on which the crediting rule is determined.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditId":{
            "type":"integer",
            "description":"The unique identifier assigned to the credit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditType":{
            "maxLength":30,
            "type":"string",
            "description":"The possible values are direct, indirect, and summarized.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerId":{
            "type":"number",
            "description":"The unique identifier for the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EligibleCatId":{
            "type":"integer",
            "description":"The eligible category populated during classification.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalCurrency":{
            "maxLength":10,
            "type":"string",
            "description":"The code indicating the processing currency for the credit amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The interval number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalTypeId":{
            "type":"integer",
            "description":"The unique identifier of the interval type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"number",
            "description":"The unique identifier for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The invoice date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"The identifier of the business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the participant with whom the earnings are associated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The party identifier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "type":"string",
            "description":"The end date of the period.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodNumber":{
            "type":"integer",
            "description":"The period number.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodStartDate":{
            "type":"string",
            "description":"The start date of the period.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodYear":{
            "type":"integer",
            "description":"The year associated with the period.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueType":{
            "maxLength":30,
            "type":"string",
            "description":"The possible values are revenue, nonrevenue, and custom revenue type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceEventDate":{
            "type":"string",
            "description":"The date on which the transaction was processed in the source system.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceEventPeriodId":{
            "type":"integer",
            "description":"The period ID of the source event date.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceParticipantId":{
            "type":"integer",
            "description":"The participant identifier on the source transaction associated with the credit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceSystemId":{
            "maxLength":60,
            "type":"string",
            "description":"The primary key of the record in the source system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTrxNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The user-friendly unique identifier of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionAmount":{
            "type":"number",
            "description":"The transaction amount in functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Generated from sequence.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"The transaction quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type attribute identifying the source of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkerNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The worker number of the credited participant.",
            "nullable":true,
            "readOnly":true,
            "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."
        }
    }
}

Back to Top