Get all customer manual adjustments
get
/fscmRestApi/resources/11.13.18.05/channelCustomerManualAdjustments
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a customer manual adjustment with the specified primary key.
Finder Variables:- ManualAdjustmentId; integer; Value that uniquely identifies the customer manual adjustment.
- PrimaryKey: Finds a customer manual adjustment with the specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AdjustByProductFlag; boolean; 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; Name of the adjustment currency.
- AdjustmentCurrencyCode; string; Abbreviation that identifies the adjustment currency.
- AdjustmentDate; string; 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; Name of the user-created adjustment reason.
- AdjustmentReasonId; integer; Value that uniquely identifies the user-created adjustment reason.
- AdjustmentType; string; Name of the user-created adjustment type.
- AdjustmentTypeCode; string; Abbreviation that identifies the adjustment type.
- AdjustmentTypeId; integer; Value that uniquely identifies the user-created adjustment type.
- AttachmentEntityName; string; Name that defines the attachment entity.
- BeneficiaryAccountNumber; string; Number of the beneficiary bill-to customer account.
- BeneficiaryAddress; string; Primary bill-to address of the beneficiary customer.
- BeneficiaryCustomer; string; Name of the beneficiary customer.
- BeneficiaryType; string; Abbreviation that identifies the type of beneficiary.
- BeneficiaryTypeCode; string; 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; Name of the beneficiary used in the manual adjustment.
- BeneficiaryValueCode; number; Value that uniquely identifies the beneficiary used in the manual adjustment.
- BusinessUnit; string; Name of the business unit.
- BusinessUnitId; integer; Value that uniquely identifies the business unit.
- CommentsForApprovers; string; Comments submitted to provide additional information to the approvers.
- CreatedBy; string; User who created the record.
- CreationDate; string; Date and time when the user created the record.
- LastUpdateDate; string; User who most recently updated the record.
- LastUpdatedBy; string; Date and time when the user most recently updated the record.
- ManualAdjustmentId; integer; Value that uniquely identifies the manual adjustment. It's a primary key that the application generates when it creates the manual adjustment.
- ManualAdjustmentNumber; string; Number that uniquely identifies the manual adjustment.
- Owner; string; Name of the person who owns the adjustment. This attribute defaults to the name of the person who creates the adjustment.
- OwnerPersonId; integer; Value that uniquely identifies the person who owns the adjustment.
- OwnerPersonNumber; string; Number that uniquely identifies the person who owns the adjustment.
- ProgramId; integer; Value that uniquely identifies the customer program.
- ProgramName; string; Name of the customer program.
- ProgramType; string; Name of the program type on which the channel program is based.
- ProgramTypeId; integer; Value that uniquely identifies the type of program on which the channel program is based.
- PromotionCode; string; Abbreviation that uniquely identifies the customer program.
- RequestedAccountingDate; string; 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; Status of the adjustment.
- StatusCode; string; Abbreviation that identifies the status of the adjustment.
- SubmittedBy; string; User who submitted the adjustment for approval.
- SubmittedDate; string; Date when the adjustment was submitted for approval.
- TransactionBillToAccountId; integer; Value that uniquely identifies the bill-to customer account on the transaction.
- TransactionBillToAccountNumber; string; Number of the bill-to customer account on the transaction.
- TransactionBillToCustomer; string; Name of the bill-to customer on the transaction.
- TransactionBillToSite; string; Name of the bill-to customer account site.
- TransactionBillToSiteAddress; string; Address of the bill-to customer account site.
- TransactionBillToSiteUseId; integer; Value that uniquely identifies the bill-to customer account site on the transaction.
- TransactionInvoiceDate; string; Date when the invoice is created.
- TransactionInvoiceNumber; string; Value that identifies the invoice number on the transaction.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelCustomerManualAdjustments-item-response
Type:
Show Source
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. -
AdjustmentTypeCode: string
Maximum Length:
30
Abbreviation that identifies the adjustment type. -
AdjustmentTypeId: integer
(int64)
Value that uniquely identifies the user-created adjustment type.
-
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. -
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. -
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. -
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.
Nested Schema : Attachments
Type:
array
Title:
Attachments
Users can attach documents pertaining to the adjustment. This can be used for audit purposes.
Show Source
Nested Schema : Descriptive Flexfields for Manual Adjustments
Type:
array
Title:
Descriptive Flexfields for Manual Adjustments
A flexible data field to capture additional information for the adjustment.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Products
Type:
array
Title:
Products
The 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 Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The 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
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The 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
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
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
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
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 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.
Nested Schema : Links
Type:
array
Title:
Links
The 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:
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
Value that uniquely identifies the item in the inventory. -
ItemDescription: string
Read Only:
true
Maximum Length:255
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all customer manual adjustments.
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"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "items": [ { "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-07", "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-13T22:38:21+00:00", "LastUpdatedBy": "channel_program_user", "AttachmentEntityName": "ADJUSTMENT", "SubmittedBy": null, "StatusCode": "ADJ_DRAFT", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100604660244", "name": "channelCustomerManualAdjustments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "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" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments", "name": "channelCustomerManualAdjustments", "kind": "collection" } ] }