Gets a single credit detail
get
/fscmRestApi/resources/11.13.18.05/incentiveServiceRequestCreditDetails/{CreditId}
Request
Path Parameters
-
CreditId(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 TopResponse
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.
Root Schema : incentiveServiceRequestCreditDetails-item-response
Type:
Show Source
object-
AdjustmentComments: string
Read Only:
trueMaximum Length:1000The reason for the adjustment. -
AdjustmentReason: string
Read Only:
trueMaximum Length:80The reason for the adjustment. -
AdjustmentStatus: string
Read Only:
trueMaximum Length:30The adjustment status. -
AreaCode: string
Read Only:
trueMaximum Length:360The area code. -
BillToAddressId: number
Read Only:
trueThe unique identifier of the billing address. -
BillToContactId: number
Read Only:
trueThe unique identifier of the billing point of contact. -
BookedDate: string
(date)
Read Only:
trueThe date when the order got booked. -
BusinessUnitName: string
Read Only:
trueMaximum Length:240The name of the business unit. -
CalcnToFuncCurrencyCnvrt: number
Read Only:
trueThe rate used to convert credit amount from calculation currency to functional currency. This column will be populated while creating record from credit UI. -
CalcnToHomeCurrencyCnvrt: number
Read Only:
trueThe rate used to convert credit amount from calculation currency to home currency. -
CalcnToSourceCurrencyCnvrt: number
Read Only:
trueThe rate used to convert amount from calculation currency to source currency. This will be populated during credit adjustment on UI. -
CalculationCurrencyCode: string
Read Only:
trueMaximum Length:15The participant's calculation currency code. -
City: string
Read Only:
trueMaximum Length:360The name of the city. -
Country: string
Read Only:
trueMaximum Length:360The name of the country. -
CrdAmountCalcnCurrency: number
Read Only:
trueThe credit amount in the calculation currency. -
CrdAmountFunctCurrency: number
Read Only:
trueThe credit amount in the functional currency. -
CrdAmountHomeCurrency: number
Read Only:
trueThe credit amount in the home currency. -
CrdAmountSourceCurrency: number
Read Only:
trueThe credit amount in the source currency. -
CreditDate: string
(date)
Read Only:
trueThe date based on which the crediting rule is determined. -
CreditedParticipantName: string
Read Only:
trueMaximum Length:360The name of the participant who's receiving credit. -
CreditId: integer
(int64)
Read Only:
trueGenerated from the sequence. -
CreditStatusMeaning: string
Read Only:
trueMaximum Length:80The status of the credit. -
CreditType: string
Read Only:
trueMaximum Length:30The possible values are direct, indirect, and summarized. -
CreditTypeMeaning: string
Read Only:
trueMaximum Length:80The credit type name. -
CustomerId: number
Read Only:
trueThe unique identifier for the customer. -
DirectParticipantId: integer
(int64)
Read Only:
trueThe participant identifier of the direct credit receiver. -
EligibleCatId: integer
(int64)
Read Only:
trueThe eligible category populated during classification. -
EligibleCreditCategory: string
Read Only:
trueMaximum Length:160The name of the credit category. -
HoldFlag: boolean
Read Only:
trueMaximum Length:1Transaction won't be considered for further processing if the flag is set to Y. -
HomeCurrencyCode: string
Read Only:
trueMaximum Length:15The participant's home currency code. -
InventoryItemId: number
Read Only:
trueThe unique identifier for the item. -
InvoiceDate: string
(date)
Read Only:
trueThe invoice date. -
InvoiceNumber: string
Read Only:
trueMaximum Length:30The unique identifier for the invoice. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectStatus: string
Read Only:
trueMaximum Length:30The status of the transaction. -
OrderNumber: string
Read Only:
trueMaximum Length:30The unique identifier for the order. -
OrgId: integer
(int64)
Read Only:
trueIndicates the identifier of the business unit associated to the row. -
ParticipantId: integer
(int64)
Read Only:
trueThe unique identifier for the sales rep of the transaction. -
PartyId: integer
(int64)
Read Only:
trueThe unique party identifier of the participant. -
PostalCode: string
Read Only:
trueMaximum Length:360The postal code. -
PreserveCreditFlag: boolean
Read Only:
trueMaximum Length:1Flag to indicate if the corresponding credit was adjusted. -
Province: string
Read Only:
trueMaximum Length:360The name of the province. -
ReasonCode: string
Read Only:
trueMaximum Length:30The reason for the adjustment. -
RevenueType: string
Read Only:
trueMaximum Length:30The possible values are revenue, nonrevenue, and custom revenue type. -
RollupDate: string
(date)
Read Only:
trueThe date based on which rollup hierarchy is determined. -
SalesChannel: string
Read Only:
trueMaximum Length:30The sales channel. -
ShipToAddressId: number
Read Only:
trueThe unique identifier of the shipping address. -
ShipToContactId: number
Read Only:
trueThe unique identifier of the shipping point of contact. -
SourceCurrencyCode: string
Read Only:
trueMaximum Length:15The currency code in which the source amounts are specified. -
SourceEventDate: string
(date)
Read Only:
trueThe date on which the transaction was processed in the source system. -
SourceEventPeriodId: integer
(int64)
Read Only:
trueThe period ID of the source event date. -
SourceSystemId: string
Read Only:
trueMaximum Length:60The unique identifier from the source system. -
SourceToCalcnCurrencyCnvrt: number
Read Only:
trueRate used to convert credit amount from source currency to calculation currency. This is populated while creating the credits in the crediting process. -
SourceToFuncCurrencyCnvrt: number
Read Only:
trueRate used to convert credit amount from source currency to functional currency. This column is populated while creating record by the crediting process. -
SourceToHomeCurrencyCnvrt: number
Read Only:
trueRate used to convert credit amount from source currency to participant's home currency. This column is populated while creating record from the crediting process. -
SourceTrxNumber: string
Read Only:
trueMaximum Length:30The user-friendly unique identifier of the transaction. -
SplitPct: number
Read Only:
trueThe split percentage. -
State: string
Read Only:
trueMaximum Length:360The name of the state. -
TransactionId: integer
(int64)
Read Only:
trueGenerated from sequence. -
TransactionQuantity: number
Read Only:
trueThe quantity of the unit sold in the transaction. -
TransactionType: string
Read Only:
trueMaximum Length:30The transaction type attribute identifying the source of the transaction. -
TransactionTypeMeaning: string
Read Only:
trueMaximum Length:80The transaction type meaning identifying the source of the transaction. -
TrnsAmountCalcnCurrency: number
Read Only:
trueThe transaction amount in the calculation currency. -
TrnsAmountFunctCurrency: number
Read Only:
trueThe transaction amount in the functional currency. -
TrnsAmountHomeCurrency: number
Read Only:
trueThe transaction amount in the home currency. -
TrnsAmountSourceCurrency: number
Read Only:
trueThe transaction amount in the source currency.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.