Jump to

• Request
• Response

Create a calculation estimation credit

post

/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits

Request

Path Parameters

• SimulationId(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=
• TransactionId(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: 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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdjustmentComments: string
  Maximum Length: 1000

  Reason for adjustment
• AdjustmentReasonCode: string
  Maximum Length: 30

  Adjustment reason code
• AdjustmentStatus: string
  Maximum Length: 30

  Adjustment status
• CollectionStatus: string
  Maximum Length: 30

  Collection status of the transaction
• CreditAmountCalculation: number
  Credit amount in calculation currency
• CreditDate: string (date-time)
  Date based on which crediting rule will be determined.
• CreditedParticipantId: integer (int64)
  Unique identifier for credited sales rep
• CreditId: integer (int64)
  Generated from the sequence
• CreditType: string
  Maximum Length: 30

  Default Value: DIRECT

  Possible values: Direct, Indirect, and Summarized
• EligibleCategoryId: integer (int64)
  The unique identifier of the eligible credit category.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• ParticipantId: integer (int64)
  The unique identifier of the participant with whom the earnings are associated.
• RevenueType: string
  Maximum Length: 30

  The possible values are revenue, nonrevenue, and custom revenue types.
• RollupDate: string (date-time)
  Date based on which rollup hierarchy will be determined
• RollupLevel: integer (int64)
  Level in the hierarchy in case of rollup credits
• SimulationId: integer (int64)
  Unique identifier for a calculation simulation.
• SourceCurrencyCode: string
  Maximum Length: 15

  Currency code in which the source amounts are specified.
• SourceEventDate: string (date-time)
  The date when transaction was processed.
• SplitPct: number
  Default Value: 100

  Split percentage

{
    "type":"object",
    "properties":{
        "AdjustmentComments":{
            "maxLength":1000,
            "type":"string",
            "description":"Reason for adjustment",
            "nullable":true
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Adjustment reason code",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Adjustment status",
            "nullable":true
        },
        "CollectionStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Collection status of the transaction",
            "nullable":true
        },
        "CreditAmountCalculation":{
            "type":"number",
            "description":"Credit amount in calculation currency",
            "nullable":true
        },
        "CreditDate":{
            "type":"string",
            "description":"Date based on which crediting rule will be determined.",
            "format":"date-time",
            "nullable":true
        },
        "CreditId":{
            "type":"integer",
            "description":"Generated from the sequence",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CreditType":{
            "maxLength":30,
            "type":"string",
            "description":"Possible values: Direct, Indirect, and Summarized",
            "nullable":false,
            "default":"DIRECT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreditedParticipantId":{
            "type":"integer",
            "description":"Unique identifier for credited sales rep",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "EligibleCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the eligible credit category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant with whom the earnings are associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "RevenueType":{
            "maxLength":30,
            "type":"string",
            "description":"The possible values are revenue, nonrevenue, and custom revenue types.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RollupDate":{
            "type":"string",
            "description":"Date based on which rollup hierarchy will be determined",
            "format":"date-time",
            "nullable":true
        },
        "RollupLevel":{
            "type":"integer",
            "description":"Level in the hierarchy in case of rollup credits",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SimulationId":{
            "type":"integer",
            "description":"Unique identifier for a calculation simulation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SourceCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency code in which the source amounts are specified.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceEventDate":{
            "type":"string",
            "description":"The date when transaction was processed.",
            "format":"date-time",
            "nullable":true
        },
        "SplitPct":{
            "type":"number",
            "description":"Split percentage",
            "nullable":true,
            "default":100
        }
    }
}

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 : incentiveCompensationEstimations-Transactions-Credits-item-response

Type: object

Show Source

• AdjustmentComments: string
  Maximum Length: 1000

  Reason for adjustment
• AdjustmentReasonCode: string
  Maximum Length: 30

  Adjustment reason code
• AdjustmentStatus: string
  Maximum Length: 30

  Adjustment status
• CalculationCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  The participant's calculation currency code.
• CalculationToHomeRate: number
  Read Only: true

  Calculation currency to home currency conversion rate.
• CalculationToSourceRate: number
  Read Only: true

  Calculation currency to source currency conversion rate.
• CollectionStatus: string
  Maximum Length: 30

  Collection status of the transaction
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  Who column: indicates the date and time of the creation of the row.
• CreditAmountCalculation: number
  Credit amount in calculation currency
• CreditAmountHome: number
  Read Only: true

  Credit amount in home currency
• CreditAmountSource: number
  Read Only: true

  Credit amount in source currency
• CreditDate: string (date-time)
  Date based on which crediting rule will be determined.
• CreditedParticipantId: integer (int64)
  Unique identifier for credited sales rep
• CreditId: integer (int64)
  Generated from the sequence
• CreditType: string
  Maximum Length: 30

  Default Value: DIRECT

  Possible values: Direct, Indirect, and Summarized
• EligibleCategoryId: integer (int64)
  The unique identifier of the eligible credit category.
• HomeCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  The participant's home currency code.
• LastUpdateDate: string (date-time)
  Read Only: true

  Who column: indicates the date and time of the last update of the row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Who column: indicates the session login associated to the user who last updated the row.
• links: array Links
  Title: Links

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

  Maximum Length: 30

  The status of the transaction. Possible values are calculated, calculation error, posted,and reversed.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• ParticipantId: integer (int64)
  The unique identifier of the participant with whom the earnings are associated.
• RevenueType: string
  Maximum Length: 30

  The possible values are revenue, nonrevenue, and custom revenue types.
• RollupDate: string (date-time)
  Date based on which rollup hierarchy will be determined
• RollupLevel: integer (int64)
  Level in the hierarchy in case of rollup credits
• SimulationId: integer (int64)
  Unique identifier for a calculation simulation.
• SourceCurrencyCode: string
  Maximum Length: 15

  Currency code in which the source amounts are specified.
• SourceEventDate: string (date-time)
  The date when transaction was processed.
• SourceToCalculationRate: number
  Read Only: true

  Source currency to calculation currency conversion rate.
• SourceToHomeRate: number
  Read Only: true

  Source currency to home currency conversion rate.
• SourceTrxNumber: string
  Read Only: true

  Maximum Length: 30

  The source_trx_number info about the transaction.
• SplitPct: number
  Default Value: 100

  Split percentage
• TransactionId: integer (int64)
  Read Only: true

  Points to the base transaction from which the earning is generated.

{
    "type":"object",
    "properties":{
        "AdjustmentComments":{
            "maxLength":1000,
            "type":"string",
            "description":"Reason for adjustment",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Adjustment reason code",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Adjustment status",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The participant's calculation currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationToHomeRate":{
            "type":"number",
            "description":"Calculation currency to home currency conversion rate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationToSourceRate":{
            "type":"number",
            "description":"Calculation currency to source currency conversion rate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CollectionStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Collection status of the transaction",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditAmountCalculation":{
            "type":"number",
            "description":"Credit amount in calculation currency",
            "nullable":true,
            "x-queryable":true
        },
        "CreditAmountHome":{
            "type":"number",
            "description":"Credit amount in home currency",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditAmountSource":{
            "type":"number",
            "description":"Credit amount in source currency",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditDate":{
            "type":"string",
            "description":"Date based on which crediting rule will be determined.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreditId":{
            "type":"integer",
            "description":"Generated from the sequence",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditType":{
            "maxLength":30,
            "type":"string",
            "description":"Possible values: Direct, Indirect, and Summarized",
            "nullable":false,
            "default":"DIRECT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreditedParticipantId":{
            "type":"integer",
            "description":"Unique identifier for credited sales rep",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "EligibleCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the eligible credit category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "HomeCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The participant's home currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Who column: indicates the session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the transaction. Possible values are calculated, calculation error, posted,and reversed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant with whom the earnings are associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueType":{
            "maxLength":30,
            "type":"string",
            "description":"The possible values are revenue, nonrevenue, and custom revenue types.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RollupDate":{
            "type":"string",
            "description":"Date based on which rollup hierarchy will be determined",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RollupLevel":{
            "type":"integer",
            "description":"Level in the hierarchy in case of rollup credits",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"Unique identifier for a calculation simulation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency code in which the source amounts are specified.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceEventDate":{
            "type":"string",
            "description":"The date when transaction was processed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceToCalculationRate":{
            "type":"number",
            "description":"Source currency to calculation currency conversion rate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceToHomeRate":{
            "type":"number",
            "description":"Source currency to home currency conversion rate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTrxNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The source_trx_number info about the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitPct":{
            "type":"number",
            "description":"Split percentage",
            "nullable":true,
            "default":100,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Points to the base transaction from which the earning is generated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "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"
            }
        }
    }
}

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

AdjustmentReasonVVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_TP_ADJUSTMENT_REASON

The following properties are defined on the LOV link relation:

• Source Attribute: AdjustmentReasonCode; Target Attribute: LookupCode
• Display Attribute: Meaning

CreditTypeVVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_TP_CREDIT_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: CreditType; Target Attribute: LookupCode
• Display Attribute: Meaning

CurrencyLOVVO

Operation: /fscmRestApi/resources/11.13.18.05/currenciesLOV

Parameters:

• finder: CurrencyCodeFinder

The following properties are defined on the LOV link relation:

• Source Attribute: SourceCurrencyCode; Target Attribute: CurrencyCode
• Display Attribute: CurrencyCode, Name

EligibleCategoryForSalesRepVVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSalesrepEligibleCategoriesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: EligibleCategoryId; Target Attribute: EligibleCategoryId
• Display Attribute: EligibleCategoryName

ObjectStatusVVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_TP_BASETRANS_OBJECT_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: ObjectStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

ParticipantsListVVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSalesrepsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: ParticipantId; Target Attribute: ParticipantId
• Display Attribute: ParticipantName

RevenueTypeVVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_RS_REVENUE_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: RevenueType; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top