Create one customer manual adjustment
/fscmRestApi/resources/11.13.18.05/channelCustomerManualAdjustments
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
-
AdjustByProductFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the adjustment is at the product level. If false, then the adjustment is at the program level. -
AdjustmentAmount: number
Amount for which manual adjustment needs to be created.
-
AdjustmentCurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the adjustment currency. -
AdjustmentDate: string
(date)
Date when the user performed the manual adjustment. This date can be a system date or any past date. Future dating isn't currently supported.
-
AdjustmentReason: string
Maximum Length:
255
Name of the user-created adjustment reason. -
AdjustmentReasonId: integer
(int64)
Value that uniquely identifies the user-created adjustment reason.
-
AdjustmentType: string
Maximum Length:
255
Name of the user-created adjustment type. -
AdjustmentTypeId: integer
(int64)
Value that uniquely identifies the user-created adjustment type.
-
ApprovedDate: string
(date)
Date when the adjustment was approved.
-
AttachmentEntityName: string
Maximum Length:
255
Name that defines the attachment entity. -
attachments: array
Attachments
Title:
Attachments
Users can attach documents pertaining to the adjustment. This can be used for audit purposes. -
BeneficiaryType: string
Maximum Length:
255
Abbreviation that identifies the type of beneficiary. -
BeneficiaryTypeCode: string
Maximum Length:
30
Type of beneficiary used in the manual adjustment. A list of accepted values is defined in the lookup type ORA_CJM_BENEFICIARY_TYPE. -
BeneficiaryValue: string
Maximum Length:
255
Name of the beneficiary used in the manual adjustment. -
BeneficiaryValueCode: number
Value that uniquely identifies the beneficiary used in the manual adjustment.
-
BusinessUnitId(required): integer
(int64)
Value that uniquely identifies the business unit.
-
CommentsForApprovers: string
Maximum Length:
1000
Comments submitted to provide additional information to the approvers. -
DFF: array
Descriptive Flexfields for Manual Adjustments
Title:
Descriptive Flexfields for Manual Adjustments
A flexible data field to capture additional information for the adjustment. -
ManualAdjustmentNumber: string
Maximum Length:
30
Number that uniquely identifies the manual adjustment. -
notes: array
Notes
Title:
Notes
The notes capture comments, information, or instructions for the adjustment. -
Owner: string
Maximum Length:
255
Name of the person who owns the adjustment. This attribute defaults to the name of the person who creates the adjustment. -
OwnerPersonId: integer
(int64)
Value that uniquely identifies the person who owns the adjustment.
-
OwnerPersonNumber: string
Maximum Length:
255
Number that uniquely identifies the person who owns the adjustment. -
PredefinedAdjustmentTypeCode: string
Maximum Length:
30
Abbreviation that identifies the predefined adjustment type. The list of values are INCREASE_EARNED and DECREASE_EARNED. -
products: array
Products
Title:
Products
The items specified in the adjustment are stamped on the adjustment accrual. -
ProgramId: integer
(int64)
Value that uniquely identifies the customer program.
-
PromotionCode: string
Maximum Length:
255
Abbreviation that uniquely identifies the customer program. -
RejectedDate: string
(date)
Date when the adjustment was rejected.
-
RequestedAccountingDate: string
(date)
Date when the claim should be accounted. This date can be a system date or any past date. Future dating isn't currently supported.
-
Status: string
Maximum Length:
255
Status of the adjustment. -
StatusCode: string
Maximum Length:
255
Abbreviation that identifies the status of the adjustment. -
SubmittedDate: string
(date)
Date when the adjustment was submitted for approval.
-
TransactionBillToAccountId: integer
(int64)
Value that uniquely identifies the bill-to customer account on the transaction.
-
TransactionBillToAccountNumber: string
Maximum Length:
255
Number of the bill-to customer account on the transaction. -
TransactionBillToSite: string
Maximum Length:
255
Name of the bill-to customer account site. -
TransactionBillToSiteUseId: integer
(int64)
Value that uniquely identifies the bill-to customer account site on the transaction.
-
TransactionInvoiceDate: string
(date)
Date when the invoice is created.
-
TransactionInvoiceNumber: string
Maximum Length:
50
Value that identifies the invoice number on the transaction.
array
Attachments
array
Descriptive Flexfields for Manual Adjustments
array
Notes
array
Products
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Document version number from which the attachment is created. -
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
Error code, 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
Expiration date of the contents in the attachment. -
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
URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
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
Size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
Text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page type attachment.
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for customer manual adjustments. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for customer manual adjustments. -
ManualAdjustmentId: integer
(int64)
Value that uniquely identifies the customer manual adjustment.
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
This is Party Id for the Note Creator -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Currency conversion rate type 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 is 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 which stores the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
Note type code for categorization of a note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
Unique identifier of the parent source object associated to the note. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
Source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
Unique identifier of the parent source object associated to 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
-
AdjustmentAmount: number
Adjustment amount for the item.
-
Item: string
Maximum Length:
300
Value that uniquely identifies the item in the inventory. -
ItemId: integer
(int64)
Name of the item in the inventory.
-
LineNumber: number
Number that identifies the adjustment line.
-
ManualAdjustmentId: integer
(int64)
Value that uniquely identifies the adjustment.
-
ManualAdjustmentLineId: integer
(int64)
Value that uniquely identifies the adjustment line. It is a primary key that the application generates when it creates the adjustment line.
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
-
AdjustByProductFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the adjustment is at the product level. If false, then the adjustment is at the program level. -
AdjustmentAmount: number
Amount for which manual adjustment needs to be created.
-
AdjustmentCurrency: string
Read Only:
true
Maximum Length:255
Name of the adjustment currency. -
AdjustmentCurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the adjustment currency. -
AdjustmentDate: string
(date)
Date when the user performed the manual adjustment. This date can be a system date or any past date. Future dating isn't currently supported.
-
AdjustmentReason: string
Maximum Length:
255
Name of the user-created adjustment reason. -
AdjustmentReasonId: integer
(int64)
Value that uniquely identifies the user-created adjustment reason.
-
AdjustmentType: string
Maximum Length:
255
Name of the user-created adjustment type. -
AdjustmentTypeId: integer
(int64)
Value that uniquely identifies the user-created adjustment type.
-
ApprovedDate: string
(date)
Date when the adjustment was approved.
-
AttachmentEntityName: string
Maximum Length:
255
Name that defines the attachment entity. -
attachments: array
Attachments
Title:
Attachments
Users can attach documents pertaining to the adjustment. This can be used for audit purposes. -
BeneficiaryAccountNumber: string
Read Only:
true
Maximum Length:255
Number of the beneficiary bill-to customer account. -
BeneficiaryAddress: string
Read Only:
true
Maximum Length:255
Primary bill-to address of the beneficiary customer. -
BeneficiaryCustomer: string
Read Only:
true
Maximum Length:255
Name of the beneficiary customer. -
BeneficiaryType: string
Maximum Length:
255
Abbreviation that identifies the type of beneficiary. -
BeneficiaryTypeCode: string
Maximum Length:
30
Type of beneficiary used in the manual adjustment. A list of accepted values is defined in the lookup type ORA_CJM_BENEFICIARY_TYPE. -
BeneficiaryValue: string
Maximum Length:
255
Name of the beneficiary used in the manual adjustment. -
BeneficiaryValueCode: number
Value that uniquely identifies the beneficiary used in the manual adjustment.
-
BusinessUnit: string
Read Only:
true
Maximum Length:255
Name of the business unit. -
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
CommentsForApprovers: string
Maximum Length:
1000
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. -
DFF: array
Descriptive Flexfields for Manual Adjustments
Title:
Descriptive Flexfields for Manual Adjustments
A flexible data field to capture additional information for the adjustment. -
LastUpdateDate: string
(date-time)
Read Only:
true
User who most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Date and time when the user most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualAdjustmentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the manual adjustment. It's a primary key that the application generates when it creates the manual adjustment. -
ManualAdjustmentNumber: string
Maximum Length:
30
Number that uniquely identifies the manual adjustment. -
notes: array
Notes
Title:
Notes
The notes capture comments, information, or instructions for the adjustment. -
Owner: string
Maximum Length:
255
Name of the person who owns the adjustment. This attribute defaults to the name of the person who creates the adjustment. -
OwnerPersonId: integer
(int64)
Value that uniquely identifies the person who owns the adjustment.
-
OwnerPersonNumber: string
Maximum Length:
255
Number that uniquely identifies the person who owns the adjustment. -
PredefinedAdjustmentTypeCode: string
Maximum Length:
30
Abbreviation that identifies the predefined adjustment type. The list of values are INCREASE_EARNED and DECREASE_EARNED. -
products: array
Products
Title:
Products
The items specified in the adjustment are stamped on the adjustment accrual. -
ProgramId: integer
(int64)
Value that uniquely identifies the customer program.
-
ProgramName: string
Read Only:
true
Maximum Length:255
Name of the customer program. -
ProgramType: string
Read Only:
true
Maximum Length:255
Name of the program type on which the channel program is based. -
ProgramTypeId: integer
Read Only:
true
Value that uniquely identifies the type of program on which the channel program is based. -
PromotionCode: string
Maximum Length:
255
Abbreviation that uniquely identifies the customer program. -
RejectedDate: string
(date)
Date when the adjustment was rejected.
-
RequestedAccountingDate: string
(date)
Date when the claim should be accounted. This date can be a system date or any past date. Future dating isn't currently supported.
-
Status: string
Maximum Length:
255
Status of the adjustment. -
StatusCode: string
Maximum Length:
255
Abbreviation that identifies the status of the adjustment. -
SubmittedBy: string
Read Only:
true
Maximum Length:255
User who submitted the adjustment for approval. -
SubmittedDate: string
(date)
Date when the adjustment was submitted for approval.
-
TransactionBillToAccountId: integer
(int64)
Value that uniquely identifies the bill-to customer account on the transaction.
-
TransactionBillToAccountNumber: string
Maximum Length:
255
Number of the bill-to customer account on the transaction. -
TransactionBillToCustomer: string
Read Only:
true
Maximum Length:255
Name of the bill-to customer on the transaction. -
TransactionBillToSite: string
Maximum Length:
255
Name of the bill-to customer account site. -
TransactionBillToSiteAddress: string
Read Only:
true
Maximum Length:255
Address of the bill-to customer account site. -
TransactionBillToSiteUseId: integer
(int64)
Value that uniquely identifies the bill-to customer account site on the transaction.
-
TransactionInvoiceDate: string
(date)
Date when the invoice is created.
-
TransactionInvoiceNumber: string
Maximum Length:
50
Value that identifies the invoice number on the transaction.
array
Attachments
array
Descriptive Flexfields for Manual Adjustments
array
Links
array
Notes
array
Products
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Document version number from which the attachment is created. -
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
Error code, 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
Expiration date of the contents in the attachment. -
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
URI of the file. -
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 who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
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
Size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
Text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login credentials of the user who created 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 customer manual adjustments. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for customer manual adjustments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualAdjustmentId: integer
(int64)
Value that uniquely identifies the customer manual adjustment.
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
This is Party Id for the Note Creator -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Currency conversion rate type 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. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30
Alternate unique identifier of the note. A user key that is 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 which stores the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
Note type code for categorization of a note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
Unique identifier of the parent source object associated to 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 OBJECTS Metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
Unique identifier of the parent source object associated to 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
-
AdjustmentAmount: number
Adjustment amount for the item.
-
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:
300
Value that uniquely identifies the item in the inventory. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item in the inventory. -
ItemId: integer
(int64)
Name of the item in the inventory.
-
LastUpdateDate: string
(date-time)
Read Only:
true
User who most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Date and time when the user most recently updated the record. -
LineNumber: number
Number that identifies the adjustment line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualAdjustmentId: integer
(int64)
Value that uniquely identifies the adjustment.
-
ManualAdjustmentLineId: integer
(int64)
Value that uniquely identifies the adjustment line. It is a primary key that the application generates when it creates the adjustment line.
array
Links
- DFF
-
Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerManualAdjustments/{ManualAdjustmentId}/child/DFFParameters:
- ManualAdjustmentId:
$request.path.ManualAdjustmentId
A flexible data field to capture additional information for the adjustment. - ManualAdjustmentId:
- attachments
-
Parameters:
- ManualAdjustmentId:
$request.path.ManualAdjustmentId
Users can attach documents pertaining to the adjustment. This can be used for audit purposes. - ManualAdjustmentId:
- notes
-
Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerManualAdjustments/{ManualAdjustmentId}/child/notesParameters:
- ManualAdjustmentId:
$request.path.ManualAdjustmentId
The notes capture comments, information, or instructions for the adjustment. - ManualAdjustmentId:
- products
-
Parameters:
- ManualAdjustmentId:
$request.path.ManualAdjustmentId
The items specified in the adjustment are stamped on the adjustment accrual. - ManualAdjustmentId:
- submit
-
Parameters:
- ManualAdjustmentId:
$request.path.ManualAdjustmentId
Action to submit a manual adjustment. - ManualAdjustmentId:
Examples
This example describes how to create one customer manual adjustment.
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/channelCustomerManualAdjustments"
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 creates.
{ "ManualAdjustmentNumber": "SB-08302024", "PromotionCode": "SBREB0830", "TransactionBillToAccountNumber": "226332", "TransactionBillToSite": "213572", "TransactionInvoiceNumber": "IN20240511B", "AdjustmentDate": "2024-08-28", "AdjustmentType": "Decrease Earned", "AdjustmentReason": "Pricing Error", "CommentsForApprovers": "Adjustment due to pricing error.", "AdjustByProductFlag": true, "AttachmentEntityName": "ADJUSTMENT", "products": [ { "Item": "AS92689", "AdjustmentAmount": 100.00 } ], "attachments": [], "DFF": [], "notes": [ { "NoteTypeCode": "GENERAL", "NoteTxt": "U3Bva2Ugd2l0aCB0aGUgY3VzdG9tZXIgdG8gY29uZmlybSB0aGUgYWRqdXN0bWVudC4=" // NoteTxt must be encoded in base64. } ] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ManualAdjustmentId": 300100637717148, "ManualAdjustmentNumber": "SB-08302024", "BusinessUnit": "Vision Operations", "BusinessUnitId": 204, "PromotionCode": "SBREB0830", "ProgramId": 300100637716916, "ProgramName": "2024 Fall rebate", "ProgramType": "Customer Promotion Type", "ProgramTypeId": 300100580716126, "BeneficiaryType": null, "BeneficiaryTypeCode": null, "BeneficiaryValue": null, "BeneficiaryValueCode": null, "BeneficiaryCustomer": null, "BeneficiaryAccountNumber": null, "BeneficiaryAddress": null, "TransactionBillToCustomer": "Spruce Street Foods", "TransactionBillToAccountNumber": "226332", "TransactionBillToAccountId": 300100581001730, "TransactionBillToSite": "213572", "TransactionBillToSiteUseId": 300100581001734, "TransactionBillToSiteAddress": "217 Hanover Street,BOSTON, MA 02113", "TransactionInvoiceNumber": "IN20240511B", "TransactionInvoiceDate": "2024-08-12", "AdjustmentAmount": 100, "AdjustmentCurrency": "US Dollar", "AdjustmentCurrencyCode": "USD", "AdjustmentDate": "2024-08-28", "RequestedAccountingDate": null, "PredefinedAdjustmentTypeCode": "DECREASE_EARNED", "AdjustmentType": "Decrease Earned", "AdjustmentTypeId": 300100614678328, "AdjustmentReason": "Pricing Error", "AdjustmentReasonId": 300100614678331, "CommentsForApprovers": "Adjustment due to pricing error.", "AdjustByProductFlag": true, "Owner": "Parker Kline", "OwnerPersonId": 300100583360588, "OwnerPersonNumber": "955160008195114", "Status": "Draft", "SubmittedDate": null, "ApprovedDate": null, "CreatedBy": "PGM_MGR1", "CreationDate": "2024-08-31T02:49:32+00:00", "LastUpdateDate": "2024-08-31T02:49:32.684+00:00", "LastUpdatedBy": "PGM_MGR1", "AttachmentEntityName": "ADJUSTMENT", "SubmittedBy": null, "StatusCode": "ADJ_DRAFT", "RejectedDate": null, "products": [ { "ManualAdjustmentLineId": 300100637717149, "ManualAdjustmentId": 300100637717148, "LineNumber": 1, "ItemId": 151, "AdjustmentAmount": 100.00000, "CreatedBy": "PGM_MGR1", "CreationDate": "2024-08-31T02:49:32.371+00:00", "LastUpdateDate": "2024-08-31T02:49:32.693+00:00", "LastUpdatedBy": "PGM_MGR1", "Item": "AS92689", "ItemDescription": "Envoy Standard Laptop", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148/child/products/300100637717149", "name": "products", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148/child/products/300100637717149", "name": "products", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148", "name": "channelCustomerManualAdjustments", "kind": "item" } ] } ], "notes": [ { "NoteId": 300100637717150, "SourceObjectCode": "CJM_SELL_SIDE_ADJUSTMENTS", "SourceObjectId": "300100637717148", "PartyName": "Andrea Butler", "NoteTypeCode": "GENERAL", "VisibilityCode": "INTERNAL", "CreatorPartyId": 2441, "CreatedBy": "PGM_MGR1", "CreationDate": "2024-08-31T02:49:32.460+00:00", "LastUpdateDate": "2024-08-31T02:49:32.697+00:00", "PartyId": 2441, "CorpCurrencyCode": "USD", "CurcyConvRateType": "Corporate", "CurrencyCode": "USD", "ContactRelationshipId": null, "ParentNoteId": null, "LastUpdatedBy": "PGM_MGR1", "LastUpdateLogin": "1EA74BDA2B97965AE063BB43060A51AC", "EmailAddress": "sendmail-test-discard@oracle.com", "FormattedAddress": "600 Oracle Parkway,REDWOOD SHORES, CA 94065", "FormattedPhoneNumber": "+1 ", "UpdateFlag": "true", "DeleteFlag": "true", "NoteNumber": "CDRM_89327", "NoteTitle": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148/child/notes/300100637717150", "name": "notes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148/child/notes/300100637717150", "name": "notes", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148", "name": "channelCustomerManualAdjustments", "kind": "item" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148/child/notes/300100637717150/enclosure/NoteTxt", "name": "NoteTxt", "kind": "other" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148", "name": "channelCustomerManualAdjustments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148", "name": "channelCustomerManualAdjustments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148/child/attachments", "name": "attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148/child/notes", "name": "notes", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148/child/products", "name": "products", "kind": "collection" }, { "rel": "action", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148/action/submit", "name": "submit", "kind": "other" } ] }