Create a lump-sum program
/fscmRestApi/resources/11.13.18.05/channelCustomerLumpSumPrograms
Request
-
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.
-
Upsert-Mode:
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.
- application/json
object
-
attachments: array
Attachments
Title:
Attachments
The Attachments resource is used to view, create, and update attachments. -
BillToAccountId: integer
(int64)
Value that uniquely identifies the bill-to customer.
-
BillToAccountNumber: string
Maximum Length:
255
Number of the bill-to customer account. -
BusinessUnit: string
Maximum Length:
255
Name of the business unit. -
BusinessUnitId(required): integer
(int64)
Value that uniquely identifies the business unit.
-
CommentsForApprovers: string
Maximum Length:
4000
Comments submitted to provide additional information to the approvers. -
Currency: string
Maximum Length:
255
Name of the currency used for the customer lump-sum program. -
CurrencyCode(required): string
Maximum Length:
15
Abbreviation that identifies the currency used for the customer lump-sum program. -
Customer: string
Maximum Length:
255
Name of the customer. -
CustomerType: string
Maximum Length:
255
Customer type for the lump-sum program. A list of accepted values is defined in the lookup type ORA_CJM_LS_QUALIFIER. -
CustomerTypeCode: string
Maximum Length:
30
Abbreviation that identifies the customer type for the lump-sum program. -
Description: string
Maximum Length:
1000
Description of the lump-sum program. -
DFF: array
Channel Customer Lump-Sum Program Descriptive Flexfields
Title:
Channel Customer Lump-Sum Program Descriptive Flexfields
The Channel Customer Lump-Sum Program Descriptive Flexfields resource manages additional details for a program. -
DistributionType: string
Maximum Length:
255
Distribution type used in the lump-sum program. -
DistributionTypeCode: string
Maximum Length:
30
Abbreviation that identifies the distribution type used in the lump-sum program. -
LumpsumAmount: number
Lump-sum program amount.
-
notes: array
Notes
Title:
Notes
The Notes resource is used to view, create, and update notes. -
Owner: string
Maximum Length:
255
Name of the person who owns the customer lump-sum program. This attribute defaults to the name of the person who creates the program. -
OwnerId: integer
(int64)
Value that uniquely identifies the person who owns the customer lump-sum program.
-
OwnerPersonNumber: string
Maximum Length:
255
Number that uniquely identifies the person who owns the customer lump-sum program. -
productDistributions: array
Product Distributions
Title:
Product Distributions
The Product Distributions resource manages eligible products for a lump-sum program and their amount distribution. -
ProgramName(required): string
Title:
Name
Maximum Length:240
Name of the customer lump-sum program. -
ProgramType: string
Maximum Length:
255
Type of program on which the customer lump-sum program is based. -
ProgramTypeId(required): integer
(int64)
Value that uniquely identifies the type of program on which the customer lump-sum program is based.
-
PromotionCode: string
Maximum Length:
30
Abbreviation that uniquely identifies the customer lump-sum program. -
Status: string
Maximum Length:
255
Status of the customer lump-sum program. -
StatusId(required): integer
(int64)
Value that uniquely identifies the status of the customer lump-sum program.
array
Attachments
array
Channel Customer Lump-Sum Program Descriptive Flexfields
array
Notes
array
Product Distributions
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Code indicating the type of data in the attachment. For example, FILE, WEB_PAGE, or TEXT. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment.
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for the customer lump-sum program. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for the customer lump-sum program. -
ProgramHeaderId: integer
(int64)
Value that uniquely identifies the customer lump-sum program.
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
Relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
Corporate currency code for extensibility. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Party ID of the note creator. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Type of currency conversion rate for extensibility. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Currency code for extensibility. -
NoteNumber: string
Maximum Length:
30
Alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
Title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
Column that stores the note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
Note type code for categorization of the note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
Unique identifier of the parent source object associated with the note. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
Source object code for the source object as defined in the OBJECTS metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
Unique identifier of the parent source object associated with the note. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
object
-
Amount: number
Value that identifies the product distribution in amount.
-
Item: string
Maximum Length:
255
Name of the item in the inventory. -
ItemDescription: string
Maximum Length:
255
Description of the item in the inventory. -
ItemId: integer
(int64)
Value that uniquely identifies the item in the inventory.
-
LineNumber: integer
(int64)
Number that indicates the product distribution line.
-
Percent: number
Value that identifies the product distribution in percentage.
-
ProgramId: integer
(int64)
Value that uniquely identifies the customer lump-sum program.
Response
- application/json
Default Response
-
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.
object
-
AccountedLumpsumAmount: number
Read Only:
true
Indicates the amount defined for the lump-sum program in the functional currency. -
ApprovedDate: string
(date)
Read Only:
true
Date when the program is approved and moved to active status. -
attachments: array
Attachments
Title:
Attachments
The Attachments resource is used to view, create, and update attachments. -
BillToAccountId: integer
(int64)
Value that uniquely identifies the bill-to customer.
-
BillToAccountNumber: string
Maximum Length:
255
Number of the bill-to customer account. -
BillToSite: string
Read Only:
true
Maximum Length:255
Name of the bill-to customer account site. -
BillToSiteAddress: string
Read Only:
true
Maximum Length:255
Address of the bill-to customer account site. -
BillToSiteId: integer
Read Only:
true
Value that uniquely identifies the bill-to customer account site. -
BusinessUnit: string
Maximum Length:
255
Name of the business unit. -
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
CommentsForApprovers: string
Maximum Length:
4000
Comments submitted to provide additional information to the approvers. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
Currency: string
Maximum Length:
255
Name of the currency used for the customer lump-sum program. -
CurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the currency used for the customer lump-sum program. -
Customer: string
Maximum Length:
255
Name of the customer. -
CustomerType: string
Maximum Length:
255
Customer type for the lump-sum program. A list of accepted values is defined in the lookup type ORA_CJM_LS_QUALIFIER. -
CustomerTypeCode: string
Maximum Length:
30
Abbreviation that identifies the customer type for the lump-sum program. -
Description: string
Maximum Length:
1000
Description of the lump-sum program. -
DFF: array
Channel Customer Lump-Sum Program Descriptive Flexfields
Title:
Channel Customer Lump-Sum Program Descriptive Flexfields
The Channel Customer Lump-Sum Program Descriptive Flexfields resource manages additional details for a program. -
DistributionType: string
Maximum Length:
255
Distribution type used in the lump-sum program. -
DistributionTypeCode: string
Maximum Length:
30
Abbreviation that identifies the distribution type used in the lump-sum program. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LumpsumAmount: number
Lump-sum program amount.
-
notes: array
Notes
Title:
Notes
The Notes resource is used to view, create, and update notes. -
Owner: string
Maximum Length:
255
Name of the person who owns the customer lump-sum program. This attribute defaults to the name of the person who creates the program. -
OwnerId: integer
(int64)
Value that uniquely identifies the person who owns the customer lump-sum program.
-
OwnerPersonNumber: string
Maximum Length:
255
Number that uniquely identifies the person who owns the customer lump-sum program. -
productDistributions: array
Product Distributions
Title:
Product Distributions
The Product Distributions resource manages eligible products for a lump-sum program and their amount distribution. -
ProgramId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer lump-sum program. -
ProgramName: string
Title:
Name
Maximum Length:240
Name of the customer lump-sum program. -
ProgramTemplate: string
Read Only:
true
Maximum Length:255
Name of the predefined program template on which the customer lump-sum program is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE. -
ProgramTemplateCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the predefined program template on which the customer lump-sum program is based. -
ProgramType: string
Maximum Length:
255
Type of program on which the customer lump-sum program is based. -
ProgramTypeId: integer
(int64)
Value that uniquely identifies the type of program on which the customer lump-sum program is based.
-
PromotionCode: string
Maximum Length:
30
Abbreviation that uniquely identifies the customer lump-sum program. -
RejectedDate: string
(date)
Read Only:
true
Date when the program is rejected. -
StartDate: string
(date)
Read Only:
true
Date from when the program is applicable. -
Status: string
Maximum Length:
255
Status of the customer lump-sum program. -
StatusId: integer
(int64)
Value that uniquely identifies the status of the customer lump-sum program.
-
SubmittedBy: string
Read Only:
true
Maximum Length:255
Name that identifies the user who submitted the program for approval. -
SubmittedDate: string
(date)
Read Only:
true
Date when the program is submitted. -
SystemStatus: string
Read Only:
true
Maximum Length:255
System status of the customer lump-sum program. -
SystemStatusCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the system status of the customer lump-sum program. -
SystemStatusId: integer
(int64)
Read Only:
true
Value that uniquely identifies the system status of the customer lump-sum program.
array
Attachments
array
Channel Customer Lump-Sum Program Descriptive Flexfields
array
Links
array
Notes
array
Product Distributions
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the person who uploaded the image. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Code indicating the type of data in the attachment. For example, FILE, WEB_PAGE, or TEXT. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64-encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
User name of the person who last updated the image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login associated with the attachment.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for the customer lump-sum program. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for the customer lump-sum program. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramHeaderId: integer
(int64)
Value that uniquely identifies the customer lump-sum program.
array
Links
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
Relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
Corporate currency code for extensibility. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Party ID of the note creator. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Type of currency conversion rate for extensibility. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Currency code for extensibility. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the user has access to delete the note. -
EmailAddress: string
Read Only:
true
Maximum Length:320
Email address of the user who created the note. -
FormattedAddress: string
Read Only:
true
Address of the user who created the note. -
FormattedPhoneNumber: string
Read Only:
true
Phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the record -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
Unique identifier of the note. It's the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30
Alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
Title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
Column that stores the note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
Note type code for categorization of the note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
Unique identifier of the parent source object associated with the note. -
PartyId: integer
(int64)
Read Only:
true
Unique identifier of the party. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
Name of the party. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
Source object code for the source object as defined in the OBJECTS metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
Unique identifier of the parent source object associated with the note. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the user can update the note. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
array
Links
object
-
Amount: number
Value that identifies the product distribution in amount.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
Item: string
Maximum Length:
255
Name of the item in the inventory. -
ItemDescription: string
Maximum Length:
255
Description of the item in the inventory. -
ItemId: integer
(int64)
Value that uniquely identifies the item in the inventory.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login of the user who last updated the record. -
LineNumber: integer
(int64)
Number that indicates the product distribution line.
-
LineType: string
Read Only:
true
Maximum Length:255
Level at which product distributions are defined. Valid value includes Item. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL. -
LineTypeCode: string
Read Only:
true
Maximum Length:30
Default Value:ORA_ITEM
Abbreviation that identifies the level at which product distributions are defined. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Percent: number
Value that identifies the product distribution in percentage.
-
ProductDistributionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the product distribution. It's a primary key that the application generates when it creates the product distribution. -
ProgramId: integer
(int64)
Value that uniquely identifies the customer lump-sum program.
array
Links
- DFF
-
Parameters:
- ProgramId:
$request.path.ProgramId
The Channel Customer Lump-Sum Program Descriptive Flexfields resource manages additional details for a program. - ProgramId:
- attachments
-
Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerLumpSumPrograms/{ProgramId}/child/attachmentsParameters:
- ProgramId:
$request.path.ProgramId
The Attachments resource is used to view, create, and update attachments. - ProgramId:
- notes
-
Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerLumpSumPrograms/{ProgramId}/child/notesParameters:
- ProgramId:
$request.path.ProgramId
The Notes resource is used to view, create, and update notes. - ProgramId:
- productDistributions
-
Parameters:
- ProgramId:
$request.path.ProgramId
The Product Distributions resource manages eligible products for a lump-sum program and their amount distribution. - ProgramId:
- submit
-
Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerLumpSumPrograms/{ProgramId}/action/submitParameters:
- ProgramId:
$request.path.ProgramId
Action to submit a program. - ProgramId:
Examples
This example describes how to create one channel customer lump sum program.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "ProgramTypeId": 300100574245527, "BusinessUnitId": 204, "ProgramName": "Pontiac Lumpsum Sales-20JUNe", "CurrencyCode": "EUR", "Status": "Active", "OwnerId": 185, "LumpsumAmount": 110, "Description": "Lumpusm Program for Pontiac Customer", "CustomerTypeCode": "ORA_BILL_TO_CUSTOMER_ACCOUNT", "Customer": "Pontiac", "DistributionType": "Amount", //"DistributionType": "Percent", "productDistributions": [ { "Item": "AS72111", "Amount": 20 // "Percent": 20 }, { "Item": "AS54888", "Amount": 30 //"Percent": 20 }, { "Item": "AS54999", "Amount": 40 //"Percent": 20 }, { "Item": "AS1", "Amount": 10 //"Percent": 20 }, { "Item": "AS2", "Amount": 10 //"Percent": 20 } ], "notes": [ { "NoteTypeCode": "GENERAL", "VisibilityCode": "INTERNAL", "NoteTxt": "Q2xhaW0gTm90ZXMgVGVzdCBhZGRlZCBmcm9tIFJFU1QgQVBJ" } ], "attachments": [ { "DatatypeCode": "TEXT", "CategoryName": "MISC", "UploadedText": "This is a sample text attachment", "Title": "REST Attachment Text Test", "Description": "Text Attachment" } ] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ProgramId": 300100603752638, "ProgramType": "Lumpsum Program Earnings", "ProgramTypeId": 300100574245527, "ProgramTemplate": "Customer Lump Sum", "ProgramTemplateCode": "CUSTOMER_LUMP_SUM", "BusinessUnit": "Vision Operations", "BusinessUnitId": 204, "ProgramName": "Pontiac Lumpsum Sales-20JUNe", "PromotionCode": "LUMP148009", "Owner": "TAX_ACCT_OPERATIONS", "OwnerId": 185, "Status": "Active", "StatusId": 100100144204820, "SystemStatus": "Active", "SystemStatusId": 100100144204820, "SystemStatusCode": "ACTIVE", "StartDate": "2023-07-25", "Currency": "Euro", "CurrencyCode": "EUR", "Description": "Lumpusm Program for Pontiac Customer", "CustomerType": "Customer", "CustomerTypeCode": "ORA_BILL_TO_CUSTOMER_ACCOUNT", "Customer": "Pontiac", "BillToAccountNumber": "1009", "BillToAccountId": 2440, "BillToSite": "GDAY", "BillToSiteId": 2966, "BillToSiteAddress": "26 Centerville Road,CLEVELAND, OH 44034", "LumpsumAmount": 110.00, "DistributionType": "Amount", "DistributionTypeCode": "ORA_AMOUNT", "CreatedBy": "channel_user", "CreationDate": "2023-07-25T04:03:32+00:00", "LastUpdatedBy": "channel_user", "LastUpdateDate": "2023-07-25T04:03:33.239+00:00", "attachments": [ { "AttachedDocumentId": 300100603752646, "LastUpdateDate": "2023-07-25T04:03:33.894+00:00", "LastUpdatedBy": "channel_user", "DatatypeCode": "TEXT", "FileName": "This is a sample text attachme...", "DmFolderPath": null, "DmDocumentId": "UCMFA00636411", "DmVersionNumber": "636358", "Url": null, "CategoryName": "MISC", "UserName": "Miscellaneous", "Uri": null, "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID:636358?download&XFND_SCHEME_ID=1&XFND_CERT_FP=2EE0BF8ACB4CBC57590B7FC9E0B9AA9E2F2697F9&XFND_RANDOM=4279491546145721193&XFND_EXPIRES=1690258413978&XFND_SIGNATURE=G0fI8I-3iKsJ1CY9WZvPydV1iF2hhpFJdM0mv0sQBTQzsHeKRtGgGhFZGJXXsHrI0ql66hOqR3fU0m1x2u9cTdVyPJK-iVPBWCRbqmXlfSyYw1jDfQ0my-nFDSFPjzNG-thiPtBkuqFdPhKolamRTQOZM2M3fU-e2t3Otc0lWKX2JkrE4mP6hqCHBth7S7KbXzB6HMMYCV5r0PLceY0mIkYZWwcSW2eUZmgNc2v7UxtXrb9cEjIZePSU1P6g~ik9EHQ-0pE3g5nde9anVVd8mWaOjSH08e~Ha4FSDbubTLCT5Gi9mqYm7wFXNLQUeyunGKlAm7CSAmN23vHXed1k7w__&Id=636358", "UploadedText": null, "UploadedFileContentType": "text/plain", "UploadedFileLength": 35, "UploadedFileName": "REST Attachment Text Test-f840dc0f-70ca-4ccf-af92-c57c0de872d6.txt", "ContentRepositoryFileShared": "false", "Title": "REST Attachment Text Test", "Description": "Text Attachment", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "channel_user", "CreationDate": "2023-07-25T04:03:33.126+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "Evans Sonneshein", "CreatedByUserName": "Evans Sonneshein", "AsyncTrackerId": null, "DownloadInfo": "{\"XFND_EXPIRES\":\"1690258413982\",\"XFND_SCHEME_ID\":\"1\",\"XFND_CERT_FP\":\"2EE0BF8ACB4CBC57590B7FC9E0B9AA9E2F2697F9\",\"XFND_SIGNATURE\":\"PYkQgHS59uZj~joo3Or-9l~~Hd25QQQ0BPEHdbVGJUtlluGsS8V7l51y-a4x4neYui0u~4xNlogJNMDA2sP7syBt0aN-AitX05UdFCE-zte7uV8H6g4Fdt697gIBT72v1cxHfxVL2gKUrP5EoAYFUDNj4HEaetowg9rGdrLbFESe57-0OE0adxeYsdjPEp8rStpkPia28FtWG~ZOTkPj7AykEYavxFcuimLQnUxrNhuysryERiqyHA-vawoJQxONOQKO7BhPha488P9xrAWzPpWSo9h3X3WN1MttZUeJqZjr2mj1iPjc-PElupNpOy2dNTN-mis79nVVYI7YoKIGrw__\",\"XFND_RANDOM\":\"1867664479186078449\"}", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/attachments/00020000000EACED00057708000110F09DE230C60000000EACED00057708000110F09DE230C5", "name": "attachments", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/attachments/00020000000EACED00057708000110F09DE230C60000000EACED00057708000110F09DE230C5", "name": "attachments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638", "name": "channelCustomerLumpSumPrograms", "kind": "item" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/attachments/00020000000EACED00057708000110F09DE230C60000000EACED00057708000110F09DE230C5/enclosure/FileContents", "name": "FileContents", "kind": "other" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/attachments/00020000000EACED00057708000110F09DE230C60000000EACED00057708000110F09DE230C5/enclosure/FileWebImage", "name": "FileWebImage", "kind": "other" } ] } ], "notes": [ { "NoteId": 300100603752644, "SourceObjectCode": "CJM_SELL_SIDE_PROGRAMS", "SourceObjectId": "300100603752638", "PartyName": "Evans Sonneshein", "NoteTypeCode": "GENERAL", "VisibilityCode": "INTERNAL", "CreatorPartyId": 300100574243564, "CreatedBy": "channel_user", "CreationDate": "2023-07-25T04:03:32.700+00:00", "LastUpdateDate": "2023-07-25T04:03:33.263+00:00", "PartyId": 300100574243564, "CorpCurrencyCode": "USD", "CurcyConvRateType": "Corporate", "CurrencyCode": "USD", "ContactRelationshipId": null, "ParentNoteId": null, "LastUpdatedBy": "channel_user", "LastUpdateLogin": "006881E0F7D6974BE0637A6215ACA99E", "EmailAddress": "sendmail-test-discard@oracle.com", "FormattedAddress": null, "FormattedPhoneNumber": null, "UpdateFlag": "true", "DeleteFlag": "true", "NoteNumber": "CDRM_98323", "NoteTitle": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/notes/300100603752644", "name": "notes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/notes/300100603752644", "name": "notes", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638", "name": "channelCustomerLumpSumPrograms", "kind": "item" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/notes/300100603752644/enclosure/NoteTxt", "name": "NoteTxt", "kind": "other" } ] } ], "productDistributions": [ { "ProductDistributionId": 300100603752639, "ProgramId": 300100603752638, "LineNumber": 1, "LineType": "Item", "LineTypeCode": "ORA_ITEM", "ItemId": 628, "Item": "AS72111", "ItemDescription": "Envoy Deluxe Laptop", "Percent": null, "Amount": 20, "CreatedBy": "channel_user", "CreationDate": "2023-07-25T04:03:32.509+00:00", "LastUpdatedBy": "channel_user", "LastUpdateDate": "2023-07-25T04:03:33.257+00:00", "LastUpdateLogin": "006881E0F7D6974BE0637A6215ACA99E", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/productDistributions/300100603752639", "name": "productDistributions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/productDistributions/300100603752639", "name": "productDistributions", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638", "name": "channelCustomerLumpSumPrograms", "kind": "item" } ] }, { "ProductDistributionId": 300100603752640, "ProgramId": 300100603752638, "LineNumber": 2, "LineType": "Item", "LineTypeCode": "ORA_ITEM", "ItemId": 149, "Item": "AS54888", "ItemDescription": "Standard Desktop", "Percent": null, "Amount": 30, "CreatedBy": "channel_user", "CreationDate": "2023-07-25T04:03:32.655+00:00", "LastUpdatedBy": "channel_user", "LastUpdateDate": "2023-07-25T04:03:33.259+00:00", "LastUpdateLogin": "006881E0F7D6974BE0637A6215ACA99E", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/productDistributions/300100603752640", "name": "productDistributions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/productDistributions/300100603752640", "name": "productDistributions", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638", "name": "channelCustomerLumpSumPrograms", "kind": "item" } ] }, { "ProductDistributionId": 300100603752641, "ProgramId": 300100603752638, "LineNumber": 3, "LineType": "Item", "LineTypeCode": "ORA_ITEM", "ItemId": 2155, "Item": "AS54999", "ItemDescription": "Sentinel Standard Desktop - Rugged", "Percent": null, "Amount": 40, "CreatedBy": "channel_user", "CreationDate": "2023-07-25T04:03:32.668+00:00", "LastUpdatedBy": "channel_user", "LastUpdateDate": "2023-07-25T04:03:33.260+00:00", "LastUpdateLogin": "006881E0F7D6974BE0637A6215ACA99E", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/productDistributions/300100603752641", "name": "productDistributions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/productDistributions/300100603752641", "name": "productDistributions", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638", "name": "channelCustomerLumpSumPrograms", "kind": "item" } ] }, { "ProductDistributionId": 300100603752642, "ProgramId": 300100603752638, "LineNumber": 4, "LineType": "Item", "LineTypeCode": "ORA_ITEM", "ItemId": 999997500684155, "Item": "AS1", "ItemDescription": "Support - Sleepycat Public for Berkeley Database License", "Percent": null, "Amount": 10, "CreatedBy": "channel_user", "CreationDate": "2023-07-25T04:03:32.678+00:00", "LastUpdatedBy": "channel_user", "LastUpdateDate": "2023-07-25T04:03:33.261+00:00", "LastUpdateLogin": "006881E0F7D6974BE0637A6215ACA99E", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/productDistributions/300100603752642", "name": "productDistributions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/productDistributions/300100603752642", "name": "productDistributions", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638", "name": "channelCustomerLumpSumPrograms", "kind": "item" } ] }, { "ProductDistributionId": 300100603752643, "ProgramId": 300100603752638, "LineNumber": 5, "LineType": "Item", "LineTypeCode": "ORA_ITEM", "ItemId": 999997500683349, "Item": "AS2", "ItemDescription": "Siebel Applications Bundle - AS2", "Percent": null, "Amount": 10, "CreatedBy": "channel_user", "CreationDate": "2023-07-25T04:03:32.684+00:00", "LastUpdatedBy": "channel_user", "LastUpdateDate": "2023-07-25T04:03:33.262+00:00", "LastUpdateLogin": "006881E0F7D6974BE0637A6215ACA99E", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/productDistributions/300100603752643", "name": "productDistributions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/productDistributions/300100603752643", "name": "productDistributions", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638", "name": "channelCustomerLumpSumPrograms", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638", "name": "channelCustomerLumpSumPrograms", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638", "name": "channelCustomerLumpSumPrograms", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/attachments", "name": "attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/notes", "name": "notes", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerLumpSumPrograms/300100603752638/child/productDistributions", "name": "productDistributions", "kind": "collection" } ] }