Jump to

• Request
• Response
• Examples

Get one customer manual adjustment

get

/fscmRestApi/resources/11.13.18.05/channelCustomerManualAdjustments/{ManualAdjustmentId}

Request

Path Parameters

• ManualAdjustmentId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: 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-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

  The attachments resource is used to view, create, and update attachments.
• 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 DFF
• 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 note objects resource is used to view the note objects.
• 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":{
        "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
        },
        "AdjustmentAmount":{
            "type":"number",
            "description":"Amount for which manual adjustment needs to be created.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentCurrency":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the adjustment currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the adjustment currency.",
            "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
        },
        "AdjustmentReason":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user-created adjustment reason.",
            "nullable":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
        },
        "AdjustmentType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user-created adjustment type.",
            "nullable":true,
            "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
        },
        "ApprovedDate":{
            "type":"string",
            "description":"Date when the adjustment was approved.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that defines the attachment entity.",
            "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
        },
        "BeneficiaryAddress":{
            "maxLength":255,
            "type":"string",
            "description":"Primary bill-to address of the beneficiary customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BeneficiaryCustomer":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the beneficiary customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "BeneficiaryValue":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the beneficiary used in the manual adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "BeneficiaryValueCode":{
            "type":"number",
            "description":"Value that uniquely identifies the beneficiary used in the manual adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "readOnly":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
        },
        "CommentsForApprovers":{
            "maxLength":1000,
            "type":"string",
            "description":"Comments submitted to provide additional information to the approvers.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created 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
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/channelCustomerManualAdjustments-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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
        },
        "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
        },
        "ManualAdjustmentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the manual adjustment.",
            "nullable":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
        },
        "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
        },
        "OwnerPersonNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the person who owns the adjustment.",
            "nullable":true,
            "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
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the customer program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "PromotionCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the customer program.",
            "nullable":true,
            "x-queryable":true
        },
        "RejectedDate":{
            "type":"string",
            "description":"Date when the adjustment was rejected.",
            "format":"date",
            "nullable":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
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the status of the adjustment.",
            "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
        },
        "SubmittedDate":{
            "type":"string",
            "description":"Date when the adjustment was submitted for approval.",
            "format":"date",
            "nullable":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
        },
        "TransactionBillToAccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the bill-to customer account on the transaction.",
            "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
        },
        "TransactionBillToSite":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the bill-to customer account site.",
            "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
        },
        "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
        },
        "TransactionInvoiceDate":{
            "type":"string",
            "description":"Date when the invoice is created.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionInvoiceNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Value that identifies the invoice number on the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerManualAdjustments-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The note objects resource is used to view the note objects.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerManualAdjustments-notes-item-response"
            }
        },
        "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"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

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

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerManualAdjustments-attachments-item-response"
    }
}

Nested Schema : DFF

Type: array

Show Source

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

{
    "type":"array",
    "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 note objects resource is used to view the note objects.

Show Source

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

{
    "title":"Notes",
    "type":"array",
    "description":"The note objects resource is used to view the note objects.",
    "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

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The 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

  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.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The 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
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The 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
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The 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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The 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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The 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":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The 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":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The 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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualAdjustmentId: integer (int64)

{
    "type":"object",
    "properties":{
        "ManualAdjustmentId":{
            "type":"integer",
            "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":"Context Segment",
            "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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

  The relationship ID populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code for extensibility.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique identifier of the party.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type for extensibility.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The 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

  The email address of the user who created the note.
• FormattedAddress: string
  Read Only: true

  The address of the user who created the note.
• FormattedPhoneNumber: string
  Read Only: true

  The phone number of the user who created the note.
• 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: 64

  The unique identifier of the note. This is the primary key of the notes table.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The 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

  The unique identifier of the note. This is the primary key of the notes table.
• NoteNumber: string
  Maximum Length: 30

  The alternate unique identifier of the note. A user key that's system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  The title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  The column which stores the actual note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  The note type code for categorization of note.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  The unique identifier of the note. This is the primary key of the notes table.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier of the party.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  The name of the party.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  This is the source object code for the source object as defined in OBJECTS Metadata.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The 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

  The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.

{
    "type":"object",
    "properties":{
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The relationship ID populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code for extensibility.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The 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
        },
        "FormattedAddress":{
            "type":"string",
            "description":"The address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Country",
                    "IdenAddrLocationId",
                    "PersonalAddressFlag"
                ]
            }
        },
        "FormattedPhoneNumber":{
            "type":"string",
            "description":"The phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The 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":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the note. This is the primary key of the notes table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The 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
        },
        "NoteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The 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
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The note type code for categorization of note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the note. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":30,
            "type":"string",
            "description":"This is the source object code for the source object as defined in OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the parent source object associated to the note.",
            "nullable":false,
            "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
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can update the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"The 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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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's a primary key that the application generates when it creates the adjustment line.

{
    "type":"object",
    "properties":{
        "AdjustmentAmount":{
            "type":"number",
            "description":"Adjustment amount for the item.",
            "nullable":false,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created 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
        },
        "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
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that identifies the adjustment line.",
            "nullable":true,
            "x-queryable":false
        },
        "ManualAdjustmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ManualAdjustmentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment line. It's a primary key that the application generates when it creates the adjustment line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerManualAdjustments/{ManualAdjustmentId}/child/DFF

Parameters:

• ManualAdjustmentId: $request.path.ManualAdjustmentId

attachments

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerManualAdjustments/{ManualAdjustmentId}/child/attachments

Parameters:

• ManualAdjustmentId: $request.path.ManualAdjustmentId

The attachments resource is used to view, create, and update attachments.

notes

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerManualAdjustments/{ManualAdjustmentId}/child/notes

Parameters:

• ManualAdjustmentId: $request.path.ManualAdjustmentId

The note objects resource is used to view the note objects.

products

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerManualAdjustments/{ManualAdjustmentId}/child/products

Parameters:

• ManualAdjustmentId: $request.path.ManualAdjustmentId

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

submit

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerManualAdjustments/{ManualAdjustmentId}/action/submit

Parameters:

• ManualAdjustmentId: $request.path.ManualAdjustmentId

Action to submit a manual adjustment.

Back to Top

Examples

This example describes how to get one customer manual adjustment.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/ManualAdjustmentId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/channelCustomerManualAdjustments/300100637717148"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "ManualAdjustmentId": 300100637717148,
    "ManualAdjustmentNumber": "SB-08302024",
    "BusinessUnit": "Vision Operations",
    "BusinessUnitId": 204,
    "PromotionCode": "SBREB0830",
    "ProgramId": 300100637716916,
    "ProgramName": "2024 Fall rebate",
    "ProgramType": "Customer Promotion Type",
    "ProgramTypeId": 300100580716126,
    "BeneficiaryType": null,
    "BeneficiaryTypeCode": null,
    "BeneficiaryValue": null,
    "BeneficiaryValueCode": null,
    "BeneficiaryCustomer": null,
    "BeneficiaryAccountNumber": null,
    "BeneficiaryAddress": null,
    "TransactionBillToCustomer": "Spruce Street Foods",
    "TransactionBillToAccountNumber": "226332",
    "TransactionBillToAccountId": 300100581001730,
    "TransactionBillToSite": "213572",
    "TransactionBillToSiteUseId": 300100581001734,
    "TransactionBillToSiteAddress": "217 Hanover Street,BOSTON, MA 02113",
    "TransactionInvoiceNumber": "IN20240511B",
    "TransactionInvoiceDate": "2024-08-12",
    "AdjustmentAmount": 100,
    "AdjustmentCurrency": "US Dollar",
    "AdjustmentCurrencyCode": "USD",
    "AdjustmentDate": "2024-08-28",
    "RequestedAccountingDate": null,
    "PredefinedAdjustmentTypeCode": "DECREASE_EARNED",
    "AdjustmentType": "Decrease Earned",
    "AdjustmentTypeId": 300100614678328,
    "AdjustmentReason": "Pricing Error",
    "AdjustmentReasonId": 300100614678331,
    "CommentsForApprovers": "Adjustment due to pricing error.",
    "AdjustByProductFlag": true,
    "Owner": "Parker Kline",
    "OwnerPersonId": 300100583360588,
    "OwnerPersonNumber": "955160008195114",
    "Status": "Draft",
    "SubmittedDate": null,
    "ApprovedDate": null,
    "CreatedBy": "PGM_MGR1",
    "CreationDate": "2024-08-31T02:49:32+00:00",
    "LastUpdateDate": "2024-08-31T02:49:32.684+00:00",
    "LastUpdatedBy": "PGM_MGR1",
    "AttachmentEntityName": "ADJUSTMENT",
    "SubmittedBy": null,
    "StatusCode": "ADJ_DRAFT",
    "RejectedDate": null,
    "products": [
        {
            "ManualAdjustmentLineId": 300100637717149,
            "ManualAdjustmentId": 300100637717148,
            "LineNumber": 1,
            "ItemId": 151,
            "AdjustmentAmount": 100.00000,
            "CreatedBy": "PGM_MGR1",
            "CreationDate": "2024-08-31T02:49:32.371+00:00",
            "LastUpdateDate": "2024-08-31T02:49:32.693+00:00",
            "LastUpdatedBy": "PGM_MGR1",
            "Item": "AS92689",
            "ItemDescription": "Envoy Standard Laptop"
        }
    ],
    "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
        }
    ]
}

Back to Top