Get one customer manual adjustment
get
/fscmRestApi/resources/11.13.18.05/channelCustomerManualAdjustments/{ManualAdjustmentId}
Request
Path Parameters
-
ManualAdjustmentId(required): integer(int64)
Value that uniquely identifies the manual adjustment. It's a primary key that the application generates when it creates the manual adjustment.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : channelCustomerManualAdjustments-item-response
Type:
Show Source
object-
AdjustByProductFlag: boolean
Maximum Length:
1Contains 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:
trueMaximum Length:255Name of the adjustment currency. -
AdjustmentCurrencyCode: string
Maximum Length:
15Abbreviation 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:
255Name of the user-created adjustment reason. -
AdjustmentReasonId: integer
(int64)
Value that uniquely identifies the user-created adjustment reason.
-
AdjustmentType: string
Maximum Length:
255Name of the user-created adjustment type. -
AdjustmentTypeId: integer
(int64)
Value that uniquely identifies the user-created adjustment type.
-
AttachmentEntityName: string
Maximum Length:
255Name that defines the attachment entity. -
attachments: array
Attachments
Title:
AttachmentsUsers can attach documents pertaining to the adjustment. This can be used for audit purposes. -
BeneficiaryAccountNumber: string
Read Only:
trueMaximum Length:255Number of the beneficiary bill-to customer account. -
BeneficiaryAddress: string
Read Only:
trueMaximum Length:255Primary bill-to address of the beneficiary customer. -
BeneficiaryCustomer: string
Read Only:
trueMaximum Length:255Name of the beneficiary customer. -
BeneficiaryType: string
Maximum Length:
255Abbreviation that identifies the type of beneficiary. -
BeneficiaryTypeCode: string
Maximum Length:
30Type 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:
255Name 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:
trueMaximum Length:255Name of the business unit. -
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
CommentsForApprovers: string
Maximum Length:
1000Comments submitted to provide additional information to the approvers. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
DFF: array
Descriptive Flexfields for Manual Adjustments
Title:
Descriptive Flexfields for Manual AdjustmentsA flexible data field to capture additional information for the adjustment. -
LastUpdateDate: string
(date-time)
Read Only:
trueUser who most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Date and time when the user most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManualAdjustmentId: integer
(int64)
Read Only:
trueValue 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:
30Number that uniquely identifies the manual adjustment. -
Owner: string
Maximum Length:
255Name 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:
255Number that uniquely identifies the person who owns the adjustment. -
PredefinedAdjustmentTypeCode: string
Maximum Length:
30Abbreviation that identifies the predefined adjustment type. The list of values are INCREASE_EARNED and DECREASE_EARNED. -
products: array
Products
Title:
ProductsThe 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:
trueMaximum Length:255Name of the customer program. -
ProgramType: string
Read Only:
trueMaximum Length:255Name of the program type on which the channel program is based. -
ProgramTypeId: integer
Read Only:
trueValue that uniquely identifies the type of program on which the channel program is based. -
PromotionCode: string
Maximum Length:
255Abbreviation that uniquely identifies the customer program. -
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:
255Status of the adjustment. -
StatusCode: string
Maximum Length:
255Abbreviation that identifies the status of the adjustment. -
SubmittedBy: string
Read Only:
trueMaximum Length:255User 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:
255Number of the bill-to customer account on the transaction. -
TransactionBillToCustomer: string
Read Only:
trueMaximum Length:255Name of the bill-to customer on the transaction. -
TransactionBillToSite: string
Maximum Length:
255Name of the bill-to customer account site. -
TransactionBillToSiteAddress: string
Read Only:
trueMaximum Length:255Address 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:
50Value that identifies the invoice number on the transaction.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsUsers can attach documents pertaining to the adjustment. This can be used for audit purposes.
Show Source
Nested Schema : Descriptive Flexfields for Manual Adjustments
Type:
arrayTitle:
Descriptive Flexfields for Manual AdjustmentsA flexible data field to capture additional information for the adjustment.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Products
Type:
arrayTitle:
ProductsThe items specified in the adjustment are stamped on the adjustment accrual.
Show Source
Nested Schema : channelCustomerManualAdjustments-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueUser name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEValue that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255Document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueBase64-encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueUser name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeSize of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameName to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextText content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : channelCustomerManualAdjustments-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Descriptive flexfield context name for customer manual adjustments. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for customer manual adjustments. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManualAdjustmentId: integer
(int64)
Value that uniquely identifies the customer manual adjustment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : channelCustomerManualAdjustments-products-item-response
Type:
Show Source
object-
AdjustmentAmount: number
Adjustment amount for the item.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
Item: string
Maximum Length:
255Value that uniquely identifies the item in the inventory. -
ItemDescription: string
Read Only:
trueMaximum Length:255Description of the item in the inventory. -
ItemId: integer
(int64)
Name of the item in the inventory.
-
LastUpdateDate: string
(date-time)
Read Only:
trueUser who most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Date and time when the user most recently updated the record. -
LineNumber: number
Number that identifies the adjustment line.
-
links: array
Links
Title:
LinksThe 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.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
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:
- 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 get one customer manual adjustment.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/ManualAdjustmentId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/300100604660244"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{
"ManualAdjustmentId": 300100604660244,
"ManualAdjustmentNumber": "ADJS120002",
"BusinessUnit": "Vision Operations",
"BusinessUnitId": 204,
"PromotionCode": "CREB37000",
"ProgramId": 300100604660052,
"ProgramName": "Promotion for Seven Corp in May",
"ProgramType": "Customer Promotion Type",
"ProgramTypeId": 300100580716126,
"BeneficiaryType": null,
"BeneficiaryTypeCode": null,
"BeneficiaryValue": null,
"BeneficiaryValueCode": null,
"BeneficiaryCustomer": null,
"BeneficiaryAccountNumber": null,
"BeneficiaryAddress": null,
"TransactionBillToCustomer": "Seven Corporation",
"TransactionBillToAccountNumber": "226331",
"TransactionBillToAccountId": 300100581001701,
"TransactionBillToSite": "213567",
"TransactionBillToSiteUseId": 300100581001705,
"TransactionBillToSiteAddress": "234 10th Avenue,ELMONT, NY 11003",
"TransactionInvoiceNumber": null,
"TransactionInvoiceDate": null,
"AdjustmentAmount": null,
"AdjustmentCurrency": "US Dollar",
"AdjustmentCurrencyCode": "USD",
"AdjustmentDate": "2024-05-06",
"RequestedAccountingDate": null,
"AdjustmentTypeCode": "DECREASE_EARNED",
"AdjustmentType": "Decrease Earned Sell",
"AdjustmentTypeId": 300100600171592,
"AdjustmentReason": "Return",
"AdjustmentReasonId": 300100600171593,
"CommentsForApprovers": null,
"AdjustByProductFlag": true,
"Owner": "Evans Sonneshien1",
"OwnerPersonId": 300100590989592,
"OwnerPersonNumber": "955160008195262",
"Status": "Draft",
"SubmittedDate": null,
"CreatedBy": "channel_program_user",
"CreationDate": "2024-05-13T21:42:28+00:00",
"LastUpdateDate": "2024-05-13T21:42:28.436+00:00",
"LastUpdatedBy": "channel_program_user",
"AttachmentEntityName": "ADJUSTMENT",
"SubmittedBy": null,
"StatusCode": "ADJ_DRAFT",
"products": [
{
"ManualAdjustmentLineId": 300100604660245,
"ManualAdjustmentId": 300100604660244,
"LineNumber": 1,
"Item": "AS92689",
"ItemId": 151,
"ItemDescription": "Envoy Standard Laptop",
"AdjustmentAmount": 1500.00000,
"CreatedBy": "channel_program_user",
"CreationDate": "2024-05-13T21:42:28.274+00:00",
"LastUpdateDate": "2024-05-13T21:42:28.492+00:00",
"LastUpdatedBy": "channel_program_user",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244/child/products/300100604660245",
"name": "products",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244/child/products/300100604660245",
"name": "products",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244",
"name": "channelCustomerManualAdjustments",
"kind": "item"
}
]
},
{
"ManualAdjustmentLineId": 300100604660246,
"ManualAdjustmentId": 300100604660244,
"LineNumber": 2,
"Item": "AS72111",
"ItemId": 628,
"ItemDescription": "Envoy Deluxe Laptop",
"AdjustmentAmount": 3078.00000,
"CreatedBy": "channel_program_user",
"CreationDate": "2024-05-13T21:42:28.422+00:00",
"LastUpdateDate": "2024-05-13T21:42:28.501+00:00",
"LastUpdatedBy": "channel_program_user",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244/child/products/300100604660246",
"name": "products",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244/child/products/300100604660246",
"name": "products",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244",
"name": "channelCustomerManualAdjustments",
"kind": "item"
}
]
}
],
"attachments": [],
"DFF": [
{
"ManualAdjustmentId": 300100604660244,
"__FLEX_Context": null,
"__FLEX_Context_DisplayValue": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244/child/DFF/300100604660244",
"name": "DFF",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244/child/DFF/300100604660244",
"name": "DFF",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244",
"name": "channelCustomerManualAdjustments",
"kind": "item"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244",
"name": "channelCustomerManualAdjustments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244",
"name": "channelCustomerManualAdjustments",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244/child/products",
"name": "products",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244/action/submit",
"name": "submit",
"kind": "other"
}
]
}