Jump to

• Request
• Response
• Examples

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.
• 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.
  • AdjustmentTypeId; integer; Value that uniquely identifies the user-created adjustment type.
  • ApprovedDate; string; Date when the adjustment was approved.
  • 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.
  • PredefinedAdjustmentTypeCode; string; Abbreviation that identifies the predefined adjustment type. The list of values are INCREASE_EARNED and DECREASE_EARNED.
  • 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.
  • RejectedDate; string; Date when the adjustment was rejected.
  • 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: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : channelCustomerManualAdjustments

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerManualAdjustments-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"OrderManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object channelCustomerManualAdjustments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerManualAdjustments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : channelCustomerManualAdjustments-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "RejectedDate":{
            "type":"string",
            "description":"Date when the adjustment was rejected.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Owner":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the person who owns the adjustment. This attribute defaults to the name of the person who creates the adjustment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TransactionBillToAccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the bill-to customer account on the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionInvoiceDate":{
            "type":"string",
            "description":"Date when the invoice is created.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The notes capture comments, information, or instructions for the adjustment.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerManualAdjustments-notes-item-response"
            }
        },
        "BeneficiaryType":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the type of beneficiary.",
            "nullable":true,
            "x-queryable":true
        },
        "BeneficiaryTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type of beneficiary used in the manual adjustment. A list of accepted values is defined in the lookup type ORA_CJM_BENEFICIARY_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "DFF":{
            "title":"Descriptive Flexfields for Manual Adjustments",
            "type":"array",
            "description":"A flexible data field to capture additional information for the adjustment.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerManualAdjustments-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "StatusCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the status of the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ManualAdjustmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the manual adjustment. It's a primary key that the application generates when it creates the manual adjustment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user-created adjustment type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentCurrency":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the adjustment currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionBillToSite":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the bill-to customer account site.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "type":"number",
            "description":"Amount for which manual adjustment needs to be created.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the program type on which the channel program is based.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManualAdjustmentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the manual adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionBillToCustomer":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the bill-to customer on the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedDate":{
            "type":"string",
            "description":"Date when the adjustment was approved.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PromotionCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the customer program.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "maxLength":255,
            "type":"string",
            "description":"User who submitted the adjustment for approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentReasonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user-created adjustment reason.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionInvoiceNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Value that identifies the invoice number on the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the customer program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionBillToAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer account on the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of program on which the channel program is based.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedAccountingDate":{
            "type":"string",
            "description":"Date when the claim should be accounted. This date can be a system date or any past date. Future dating isn't currently supported.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustByProductFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionBillToSiteAddress":{
            "maxLength":255,
            "type":"string",
            "description":"Address of the bill-to customer account site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"Users can attach documents pertaining to the adjustment. This can be used for audit purposes.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerManualAdjustments-attachments-item-response"
            }
        },
        "SubmittedDate":{
            "type":"string",
            "description":"Date when the adjustment was submitted for approval.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "products":{
            "title":"Products",
            "type":"array",
            "description":"The items specified in the adjustment are stamped on the adjustment accrual.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerManualAdjustments-products-item-response"
            }
        },
        "BeneficiaryValueCode":{
            "type":"number",
            "description":"Value that uniquely identifies the beneficiary used in the manual adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the adjustment currency.",
            "nullable":true,
            "x-queryable":true
        },
        "BeneficiaryValue":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the beneficiary used in the manual adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentReason":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user-created adjustment reason.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentDate":{
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BeneficiaryCustomer":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the beneficiary customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BeneficiaryAddress":{
            "maxLength":255,
            "type":"string",
            "description":"Primary bill-to address of the beneficiary customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPersonNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the person who owns the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionBillToSiteUseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer account site on the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "TransactionBillToAccountId",
                    "TransactionBillToAccountNumber"
                ]
            },
            "x-queryable":true
        },
        "AdjustmentType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user-created adjustment type.",
            "nullable":true,
            "x-queryable":true
        },
        "BeneficiaryAccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the beneficiary bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who owns the adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PredefinedAdjustmentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the predefined adjustment type. The list of values are INCREASE_EARNED and DECREASE_EARNED.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that defines the attachment entity.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommentsForApprovers":{
            "maxLength":1000,
            "type":"string",
            "description":"Comments submitted to provide additional information to the approvers.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

Users can attach documents pertaining to the adjustment. This can be used for audit purposes.

Show Source

• Array of: object channelCustomerManualAdjustments-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"Users can attach documents pertaining to the adjustment. This can be used for audit purposes.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerManualAdjustments-attachments-item-response"
    }
}

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

• Array of: object channelCustomerManualAdjustments-DFF-item-response

{
    "title":"Descriptive Flexfields for Manual Adjustments",
    "type":"array",
    "description":"A flexible data field to capture additional information for the adjustment.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerManualAdjustments-DFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

The notes capture comments, information, or instructions for the adjustment.

Show Source

• Array of: object channelCustomerManualAdjustments-notes-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The notes capture comments, information, or instructions for the adjustment.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerManualAdjustments-notes-item-response"
    }
}

Nested Schema : Products

Type: array

Title: Products

The items specified in the adjustment are stamped on the adjustment accrual.

Show Source

• Array of: object channelCustomerManualAdjustments-products-item-response

{
    "title":"Products",
    "type":"array",
    "description":"The items specified in the adjustment are stamped on the adjustment accrual.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerManualAdjustments-products-item-response"
    }
}

Nested Schema : channelCustomerManualAdjustments-attachments-item-response

Type: object

Show Source

• 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
  Title: Shared

  Indicates whether the attachment is shared.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64-encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"User name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : channelCustomerManualAdjustments-DFF-item-response

Type: object

Show Source

• __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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for customer manual adjustments.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "ManualAdjustmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer manual adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for customer manual adjustments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : channelCustomerManualAdjustments-notes-item-response

Type: object

Show Source

• 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.
• SourceSystem: string
  Title: Source System

  Maximum Length: 30

  This is the source object code for the source object as defined in OBJECTS Metadata.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":360,
            "type":"string",
            "description":"Name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"Currency conversion rate type for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"Relationship ID populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"Currency code for extensibility.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can update the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Alternate unique identifier of the note. A user key that is system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":30,
            "type":"string",
            "description":"Source object code for the source object as defined in OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "type":"string",
            "description":"Phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Corporate currency code for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"Column which stores the actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"Title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the record",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"Unique identifier of the note. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"This is Party Id for the Note Creator",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "type":"string",
            "description":"Address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Country",
                    "IdenAddrLocationId",
                    "PersonalAddressFlag"
                ]
            }
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Note type code for categorization of a note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"Unique identifier of the parent source object associated to the note.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"Unique identifier of the parent source object associated to the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"This is the source object code for the source object as defined in OBJECTS Metadata.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : channelCustomerManualAdjustments-products-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Value that uniquely identifies the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ManualAdjustmentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment line. It is a primary key that the application generates when it creates the adjustment line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "type":"number",
            "description":"Adjustment amount for the item.",
            "nullable":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Name of the item in the inventory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ManualAdjustmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that identifies the adjustment line.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top

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": 300100637721714,
            "ManualAdjustmentNumber": "SB-083020251",
            "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-31T00:22:07+00:00",
            "LastUpdateDate": "2024-08-31T00:22:07.245+00:00",
            "LastUpdatedBy": "PGM_MGR1",
            "AttachmentEntityName": "ADJUSTMENT",
            "SubmittedBy": null,
            "StatusCode": "ADJ_DRAFT",
            "RejectedDate": null,
            "products": [
                {
                    "ManualAdjustmentLineId": 300100637721715,
                    "ManualAdjustmentId": 300100637721714,
                    "LineNumber": 1,
                    "ItemId": 151,
                    "AdjustmentAmount": 100.00000,
                    "CreatedBy": "PGM_MGR1",
                    "CreationDate": "2024-08-31T00:22:07.157+00:00",
                    "LastUpdateDate": "2024-08-31T00:22:07.303+00:00",
                    "LastUpdatedBy": "PGM_MGR1",
                    "Item": "AS92689",
                    "ItemDescription": "Envoy Standard Laptop"
                }
            ],
            "attachments": [],
            "DFF": [
                {
                    "ManualAdjustmentId": 300100637721714,
                    "__FLEX_Context": null,
                    "__FLEX_Context_DisplayValue": null
                }
            ],
            "notes": [
                {
                    "NoteId": 300100637721716,
                    "SourceObjectCode": "CJM_SELL_SIDE_ADJUSTMENTS",
                    "SourceObjectId": "300100637721714",
                    "PartyName": "Andrea Butler",
                    "NoteTypeCode": "GENERAL",
                    "VisibilityCode": "INTERNAL",
                    "CreatorPartyId": 2441,
                    "CreatedBy": "PGM_MGR1",
                    "CreationDate": "2024-08-31T00:22:07.193+00:00",
                    "LastUpdateDate": "2024-08-31T00:22:07.308+00:00",
                    "PartyId": 2441,
                    "CorpCurrencyCode": "USD",
                    "CurcyConvRateType": "Corporate",
                    "CurrencyCode": "USD",
                    "ContactRelationshipId": null,
                    "ParentNoteId": null,
                    "LastUpdatedBy": "PGM_MGR1",
                    "LastUpdateLogin": "1EA74F86C578965DE063BB43060A85A1",
                    "EmailAddress": "[e-mail]",
                    "FormattedAddress": "600 Oracle Parkway,REDWOOD SHORES, CA 94065",
                    "FormattedPhoneNumber": "+1 ",
                    "UpdateFlag": "true",
                    "DeleteFlag": "true",
                    "NoteNumber": "CDRM_89326",
                    "NoteTitle": null
                }
            ]
        },
        {
            "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"
                }
            ],
            "attachments": [],
            "DFF": [
                {
                    "ManualAdjustmentId": 300100637717148,
                    "__FLEX_Context": null,
                    "__FLEX_Context_DisplayValue": null
                }
            ],
            "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": "[e-mail]",
                    "FormattedAddress": "600 Oracle Parkway,REDWOOD SHORES, CA 94065",
                    "FormattedPhoneNumber": "+1 ",
                    "UpdateFlag": "true",
                    "DeleteFlag": "true",
                    "NoteNumber": "CDRM_89327",
                    "NoteTitle": null
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments",
            "name": "channelCustomerManualAdjustments",
            "kind": "collection"
        }
    ]
}

Back to Top