Jump to

• Request
• Response
• Examples

Get one mass claim action

get

/fscmRestApi/resources/11.13.18.05/channelCustomerMassClaimActions/{MassClaimActionId}

Request

Path Parameters

• MassClaimActionId(required): integer(int64)
  Value that uniquely identifies the mass claim action performed. The value is a primary key that the application generates when it performs the mass claim action.

Query Parameters

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

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : channelCustomerMassClaimActions-item-response

Type: object

Show Source

• attachments: array Attachments
  Title: Attachments

  The Attachments resource is used to view, create, and update attachments.
• BusinessUnit: string
  Maximum Length: 255

  Value that uniquely identifies the business unit.
• BusinessUnitId: integer (int64)
  Name of the business unit.
• ClaimAmountIncludesTax: string
  Maximum Length: 255

  Value that indicates if the claim amount includes tax.
• ClaimAmountIncludesTaxCode: string
  Maximum Length: 1

  Abbreviation that indicates if the claim amount includes tax.
• ClaimOwner: string
  Maximum Length: 255

  Name of the person who owns the claim.
• ClaimOwnerId: integer (int64)
  Value that uniquely identifies the person who owns the claim.
• ClaimReason: string
  Maximum Length: 255

  Reason for creating the claim.
• ClaimReasonId: integer (int64)
  Value that uniquely identifies the claim reason.
• claims: array Claims
  Title: Claims

  The Claims resource manages the list of claims on which the mass update or mass settlement action needs to be performed.
• ClaimType: string
  Maximum Length: 255

  Type that enable you to classify claims.
• ClaimTypeId: integer (int64)
  Value that uniquely identifies the claim type.
• 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.
• currencyTotals: array Currency Totals
  Title: Currency Totals

  The Currency Totals resource queries the claim amount totals by claim currency.
• DFF: array Descriptive Flexfields for Channel Customer Claims Actions
  Title: Descriptive Flexfields for Channel Customer Claims Actions

  The Descriptive Flexfields for Channel Customer Mass Claims Actions resource manages additional details for customer claims.
• 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.
• LedgerCurrencyCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the ledger currency.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionType: string
  Maximum Length: 255

  Type of the mass claim action.
• MassActionTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the mass claim action type. A list of accepted values is defined in the lookup type ORA_CJM_MASS_CLM_MODE.
• MassClaimActionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the mass claim action performed. The value is a primary key that the application generates when it performs the mass claim action.
• MassClaimActionNumber: string
  Maximum Length: 30

  Number that indicates the mass claim action.
• notes: array Notes
  Title: Notes

  The Notes resource captures comments, information, or instructions for Oracle Fusion Cloud Applications Suite business objects.
• NumberOfClaimsSelected: integer
  Read Only: true

  Number of claims selected for mass settlement or mass update.
• ProcessingMode: string
  Maximum Length: 255

  Indicates whether the draft or final mode is used to perform the mass action on the selected claims.
• ProcessingModeCode: string
  Maximum Length: 30

  Abbreviation that identifies the process mode. A list of accepted values is defined in the lookup type ORA_CJM_MASS_CLM_ACTION_TYPE.
• ReceivablesActivityForWriteOff: string
  Maximum Length: 255

  Name of the receivables activity for receipt write-off.
• ReceivablesActivityForWriteOffAdjustment: string
  Maximum Length: 255

  Name of the receivables activity for write-off adjustment.
• ReceivablesActivityForWriteOffAdjustmentId: integer
  Value that uniquely identifies the receivables activity for write-off adjustment.
• ReceivablesActivityForWriteOffId: integer
  Value that uniquely identifies the receivables activity for receipt write-off.
• ScheduledProcessNumber: string
  Read Only: true

  Maximum Length: 255

  Number that indicates the scheduled process.
• settlementLines: array Settlement Lines
  Title: Settlement Lines

  The Settlement Lines resource manages a set of transaction lines that are used to create settlement artifacts such as credit memos in Receivables.
• SettlementMethod: string
  Maximum Length: 255

  Name of the settlement type.
• SettlementMethodCode: string
  Abbreviation that identifies the settlement type selected to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_MASS_SETTLEMENT_METHOD.
• Status: string
  Maximum Length: 255

  Value that uniquely identifies the status of the channel claim.
• StatusId: integer (int64)
  Status of the channel claim.
• TotalClaimAmountInLedgerCurrency: number
  Read Only: true

  Total amount of the claims selected for the mass settlement or mass update in ledger currency.
• TransactionSalesperson: string
  Maximum Length: 255

  Name of the salesperson.
• TransactionSalespersonId: integer (int64)
  Value that uniquely identifies the salesperson.

{
    "type":"object",
    "properties":{
        "MassClaimActionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mass claim action performed. The value is a primary key that the application generates when it performs the mass claim action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerMassClaimActions-attachments-item-response"
            }
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The Notes resource captures comments, information, or instructions for Oracle Fusion Cloud Applications Suite business objects.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerMassClaimActions-notes-item-response"
            }
        },
        "ReceivablesActivityForWriteOffAdjustment":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the receivables activity for write-off adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "DFF":{
            "title":"Descriptive Flexfields for Channel Customer Claims Actions",
            "type":"array",
            "description":"The Descriptive Flexfields for Channel Customer Mass Claims Actions resource manages additional details for customer claims.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerMassClaimActions-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ProcessingModeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the process mode. A list of accepted values is defined in the lookup type ORA_CJM_MASS_CLM_ACTION_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingMode":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the draft or final mode is used to perform the mass action on the selected claims.",
            "nullable":true,
            "x-queryable":true
        },
        "settlementLines":{
            "title":"Settlement Lines",
            "type":"array",
            "description":"The Settlement Lines resource manages a set of transaction lines that are used to create settlement artifacts such as credit memos in Receivables.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerMassClaimActions-settlementLines-item-response"
            }
        },
        "NumberOfClaimsSelected":{
            "type":"integer",
            "description":"Number of claims selected for mass settlement or mass update.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledProcessNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that indicates the scheduled process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClaimType":{
            "maxLength":255,
            "type":"string",
            "description":"Type that enable you to classify claims.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimReasonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the claim reason.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClaimReason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason for creating the claim.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceivablesActivityForWriteOffAdjustmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receivables activity for  write-off adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "ClaimAmountIncludesTax":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates if the claim amount includes tax.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceivablesActivityForWriteOff":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the receivables activity for receipt write-off.",
            "nullable":true,
            "x-queryable":true
        },
        "LedgerCurrencyCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MassActionType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the mass claim action.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionSalesperson":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the salesperson.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimOwner":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the person who owns the claim.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimAmountIncludesTaxCode":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that indicates if the claim amount includes tax.",
            "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":"Value that uniquely identifies the status of the channel claim.",
            "nullable":true,
            "x-queryable":true
        },
        "SettlementMethod":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the settlement type.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Name of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClaimTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the claim type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClaimOwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who owns the claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "currencyTotals":{
            "title":"Currency Totals",
            "type":"array",
            "description":"The Currency Totals resource queries the claim amount totals by claim currency.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerMassClaimActions-currencyTotals-item-response"
            }
        },
        "SettlementMethodCode":{
            "type":"string",
            "description":"Abbreviation that identifies the settlement type selected to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_MASS_SETTLEMENT_METHOD.",
            "nullable":true,
            "x-queryable":false
        },
        "TotalClaimAmountInLedgerCurrency":{
            "type":"number",
            "description":"Total amount of the claims selected for the mass settlement or mass update in ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MassActionTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the mass claim action type. A list of accepted values is defined in the lookup type ORA_CJM_MASS_CLM_MODE.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionSalespersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the salesperson.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReceivablesActivityForWriteOffId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receivables activity for receipt write-off.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessUnit":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "claims":{
            "title":"Claims",
            "type":"array",
            "description":"The Claims resource manages the list of claims on which the mass update or mass settlement action needs to be performed.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerMassClaimActions-claims-item-response"
            }
        },
        "StatusId":{
            "type":"integer",
            "description":"Status of the channel claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MassClaimActionNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that indicates the mass claim action.",
            "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
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

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

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

Nested Schema : Claims

Type: array

Title: Claims

The Claims resource manages the list of claims on which the mass update or mass settlement action needs to be performed.

Show Source

• Array of: object channelCustomerMassClaimActions-claims-item-response

{
    "title":"Claims",
    "type":"array",
    "description":"The Claims resource manages the list of claims on which the mass update or mass settlement action needs to be performed.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerMassClaimActions-claims-item-response"
    }
}

Nested Schema : Currency Totals

Type: array

Title: Currency Totals

The Currency Totals resource queries the claim amount totals by claim currency.

Show Source

• Array of: object channelCustomerMassClaimActions-currencyTotals-item-response

{
    "title":"Currency Totals",
    "type":"array",
    "description":"The Currency Totals resource queries the claim amount totals by claim currency.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerMassClaimActions-currencyTotals-item-response"
    }
}

Nested Schema : Descriptive Flexfields for Channel Customer Claims Actions

Type: array

Title: Descriptive Flexfields for Channel Customer Claims Actions

The Descriptive Flexfields for Channel Customer Mass Claims Actions resource manages additional details for customer claims.

Show Source

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

{
    "title":"Descriptive Flexfields for Channel Customer Claims Actions",
    "type":"array",
    "description":"The Descriptive Flexfields for Channel Customer Mass Claims Actions resource manages additional details for customer claims.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerMassClaimActions-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 resource captures comments, information, or instructions for Oracle Fusion Cloud Applications Suite business objects.

Show Source

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

{
    "title":"Notes",
    "type":"array",
    "description":"The Notes resource captures comments, information, or instructions for Oracle Fusion Cloud Applications Suite business objects.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerMassClaimActions-notes-item-response"
    }
}

Nested Schema : Settlement Lines

Type: array

Title: Settlement Lines

The Settlement Lines resource manages a set of transaction lines that are used to create settlement artifacts such as credit memos in Receivables.

Show Source

• Array of: object channelCustomerMassClaimActions-settlementLines-item-response

{
    "title":"Settlement Lines",
    "type":"array",
    "description":"The Settlement Lines resource manages a set of transaction lines that are used to create settlement artifacts such as credit memos in Receivables.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerMassClaimActions-settlementLines-item-response"
    }
}

Nested Schema : channelCustomerMassClaimActions-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 that 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 that last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Type of content 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":"Type of content 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 that 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
        },
        "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 that 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 : channelCustomerMassClaimActions-claims-item-response

Type: object

Show Source

• Amount: number
  Read Only: true

  Amount claimed in the claim currency.
• BillToAccount: string
  Read Only: true

  Maximum Length: 30

  Number of the bill-to customer account.
• BillToAddress: string
  Read Only: true

  Maximum Length: 4000

  Address of the bill-to customer account site.
• BillToCustomer: string
  Read Only: true

  Maximum Length: 360

  Name of the bill-to customer account.
• ClaimDate: string (date)
  Read Only: true

  Date when a claim is created.
• ClaimId: integer (int64)
  Value that uniquely identifies the customer claim.
• ClaimNumber: string
  Maximum Length: 30

  Number that indicates the customer claim.
• ClaimReason: string
  Read Only: true

  Maximum Length: 120

  Reason for creating the claim.
• ClaimSource: string
  Read Only: true

  Maximum Length: 80

  Name of the claim sources.
• ClaimSourceCode: string
  Read Only: true

  Abbreviation that identifies the source of the claim.
• ClaimType: string
  Read Only: true

  Maximum Length: 120

  Type that enable you to classify claims.
• 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.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 80

  Abbreviation that identifies the currency used for the channel claim.
• CustomerReference: string
  Read Only: true

  Maximum Length: 360

  Number that identifies the reference details passed by the customer.
• 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.
• MassActionClaimId: integer (int64)
  Value that uniquely identifies a claim for mass action. The value is a primary key that the application generates when the user selects a claim for mass action
• MassClaimActionId: integer (int64)
  Value that uniquely identifies the mass claim action performed.
• Owner: string
  Read Only: true

  Maximum Length: 360

  Name of the person who owns the claim.
• ShipToSite: string
  Read Only: true

  Maximum Length: 391

  Name of the ship-to customer site.
• Status: string
  Read Only: true

  Maximum Length: 50

  Status of the channel claim.

{
    "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
        },
        "Status":{
            "maxLength":50,
            "type":"string",
            "description":"Status of the channel claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MassClaimActionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mass claim action performed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "ClaimNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that indicates the customer claim.",
            "nullable":true,
            "x-queryable":true
        },
        "Owner":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the person who owns the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer claim.",
            "format":"int64",
            "nullable":true,
            "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
        },
        "MassActionClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies a claim for mass action. The value is a primary key that the application generates when the user selects a claim for mass action",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"Amount claimed in the claim currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimSource":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the claim sources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimType":{
            "maxLength":120,
            "type":"string",
            "description":"Type that enable you to classify claims.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimSourceCode":{
            "type":"string",
            "description":"Abbreviation that identifies the source of the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToAddress":{
            "maxLength":4000,
            "type":"string",
            "description":"Address of the bill-to customer account site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the currency used for the channel claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimReason":{
            "maxLength":120,
            "type":"string",
            "description":"Reason for creating the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToSite":{
            "maxLength":391,
            "type":"string",
            "description":"Name of the ship-to customer site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerReference":{
            "maxLength":360,
            "type":"string",
            "description":"Number that identifies the reference details passed by the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToAccount":{
            "maxLength":30,
            "type":"string",
            "description":"Number of the bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToCustomer":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ClaimDate":{
            "type":"string",
            "description":"Date when a claim is created.",
            "format":"date",
            "nullable":true,
            "readOnly":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
        }
    }
}

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 : channelCustomerMassClaimActions-currencyTotals-item-response

Type: object

Show Source

• Amount: number
  Read Only: true

  Total amount of claims selected for mass settlement or mass update.
• Currency: string
  Read Only: true

  Maximum Length: 80

  Name of the currency used for the channel claim.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the currency used for the channel claim.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassClaimActionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the mass claim action performed.
• NumberOfClaims: number
  Read Only: true

  Number of claims selected for mass settlement or mass update.

{
    "type":"object",
    "properties":{
        "MassClaimActionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mass claim action performed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the currency used for the channel claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NumberOfClaims":{
            "type":"number",
            "description":"Number of claims selected for mass settlement or mass update.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the currency used for the channel claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"Total amount of claims selected for mass settlement or mass update.",
            "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 : channelCustomerMassClaimActions-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for the channel customer claim.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for the channel customer claim.
• ClaimId: integer (int64)
  Value that uniquely identifies the channel customer claim.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel customer claim.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for the channel customer claim.",
            "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
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for the channel customer claim.",
            "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_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 : channelCustomerMassClaimActions-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

  Party ID of the note creator.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  Type of currency conversion rate 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 permission to delete the note.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  Email address of the user who created the note.
• FormattedAddress: string
  Title: Primary Address

  Read Only: true

  Address of the user who created the note.
• FormattedPhoneNumber: string
  Title: Primary Phone

  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 name 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. It's a user key that's system generated.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

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

  Column that stores the note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

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

  Unique identifier of the parent source object associated with the note.
• PartyId: integer (int64)
  Title: Party ID

  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

  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 with the note.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Indicates whether the user can update the note.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  Attribute that specifies 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":"Type of currency conversion rate for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"Attribute that specifies 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. It's a user key that's system generated.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":30,
            "type":"string",
            "description":"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":{
            "title":"Primary Phone",
            "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 that stores the 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":"Party ID of the note creator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"Address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of note code for categorization of the note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "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 permission 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 with the note.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "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 with the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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 name 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 : channelCustomerMassClaimActions-settlementLines-item-response

Type: object

Show Source

• 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.
• Description: string
  Maximum Length: 240

  Description of the claim line.
• Item: string
  Maximum Length: 255

  Name of the item in the inventory.
• ItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LineType: string
  Maximum Length: 255

  Name of the type of transaction line.
• LineTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the transaction line type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassClaimActionId: integer (int64)
  Value that uniquely identifies the mass claim action performed.
• SettlementLineId: integer (int64)
  Value that uniquely identifies the claim line created in the application.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MassClaimActionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mass claim action performed.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LineTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the transaction line type.",
            "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
        },
        "Item":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SettlementLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the claim line created in the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the claim line.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LineType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the  type of transaction line.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user 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"
    }
}

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerMassClaimActions/{MassClaimActionId}/child/DFF

Parameters:

• MassClaimActionId: $request.path.MassClaimActionId

The Descriptive Flexfields for Channel Customer Mass Claims Actions resource manages additional details for customer claims.

attachments

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerMassClaimActions/{MassClaimActionId}/child/attachments

Parameters:

• MassClaimActionId: $request.path.MassClaimActionId

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

claims

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerMassClaimActions/{MassClaimActionId}/child/claims

Parameters:

• MassClaimActionId: $request.path.MassClaimActionId

The Claims resource manages the list of claims on which the mass update or mass settlement action needs to be performed.

currencyTotals

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerMassClaimActions/{MassClaimActionId}/child/currencyTotals

Parameters:

• MassClaimActionId: $request.path.MassClaimActionId

The Currency Totals resource queries the claim amount totals by claim currency.

notes

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerMassClaimActions/{MassClaimActionId}/child/notes

Parameters:

• MassClaimActionId: $request.path.MassClaimActionId

The Notes resource captures comments, information, or instructions for Oracle Fusion Cloud Applications Suite business objects.

settlementLines

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerMassClaimActions/{MassClaimActionId}/child/settlementLines

Parameters:

• MassClaimActionId: $request.path.MassClaimActionId

The Settlement Lines resource manages a set of transaction lines that are used to create settlement artifacts such as credit memos in Receivables.

Back to Top

Examples

These examples describe how to get one mass claim action and one mass claim action settlment.

Example 1

This example describes how to get one mass claim action.

Example 1 cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/MassClaimActionId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576140200"

Example 1 Response Body

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

{
    "MassClaimActionId": 300100576140200,
    "MassClaimActionNumber": "25054",
    "BusinessUnitId": 204,
    "BusinessUnit": "Vision Operations",
    "MassActionTypeCode": "ORA_CLM_MASS_UPDATE",
    "MassActionType": "Mass Update",
    "ProcessingModeCode": "ORA_FINAL_MODE",
    "ProcessingMode": "Final",
    "ClaimTypeId": 300100205262732,
    "ClaimType": "Damages",
    "ClaimOwnerId": 300100181693728,
    "ClaimOwner": "Evans Sonneshein",
    "ClaimReasonId": 300100181565223,
    "ClaimReason": "Supplier Rejection",
    "StatusId": 100100144204821,
    "Status": "Settled",
    "NumberOfClaimsSelected": 2,
    "LedgerCurrencyCode": "USD",
    "TotalClaimAmountInLedgerCurrency": 4268.23,
    "SettlementMethod": null,
    "SettlementMethodCode": null,
    "ReceivablesActivityForWriteOff": null,
    "ReceivablesActivityForWriteOffId": null,
    "ReceivablesActivityForWriteOffAdjustment": null,
    "ReceivablesActivityForWriteOffAdjustmentId": null,
    "ClaimAmountIncludesTax": null,
    "ClaimAmountIncludesTaxCode": null,
    "TransactionSalesperson": null,
    "TransactionSalespersonId": null,
    "CreatedBy": "channel_user",
    "CreationDate": "2023-05-11T05:15:32+00:00",
    "LastUpdateDate": "2023-05-11T05:15:45.756+00:00",
    "LastUpdatedBy": "channel_user",
    "ScheduledProcessNumber": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576140200",
            "name": "channelCustomerMassClaimActions",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576140200",
            "name": "channelCustomerMassClaimActions",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576140200/child/DFF",
            "name": "DFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576140200/child/attachments",
            "name": "attachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576140200/child/claims",
            "name": "claims",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576140200/child/currencyTotals",
            "name": "currencyTotals",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576140200/child/notes",
            "name": "notes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576140200/child/settlementLines",
            "name": "settlementLines",
            "kind": "collection"
        }
    ]
}

Example 2

This example describes how to get one mass claim settlement.

Example 2 cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576187996"

Example 2 Response Body

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

{
    "MassClaimActionId": 300100576187996,
    "MassClaimActionNumber": "25056",
    "BusinessUnitId": 204,
    "BusinessUnit": "Vision Operations",
    "MassActionTypeCode": "ORA_CLM_MASS_SETTLE",
    "MassActionType": "Mass Settle",
    "ProcessingModeCode": "ORA_DRAFT_MODE",
    "ProcessingMode": "Draft",
    "ClaimTypeId": 300100205262732,
    "ClaimType": "Damages",
    "ClaimOwnerId": 300100181693728,
    "ClaimOwner": "Evans Sonneshein",
    "ClaimReasonId": 300100181565223,
    "ClaimReason": "Supplier Rejection",
    "StatusId": null,
    "Status": null,
    "NumberOfClaimsSelected": 2,
    "LedgerCurrencyCode": "USD",
    "TotalClaimAmountInLedgerCurrency": 4200,
    "SettlementMethod": "Credit Memo",
    "SettlementMethodCode": "ORA_CJM_CREDIT_MEMO",
    "ReceivablesActivityForWriteOff": null,
    "ReceivablesActivityForWriteOffId": null,
    "ReceivablesActivityForWriteOffAdjustment": null,
    "ReceivablesActivityForWriteOffAdjustmentId": null,
    "ClaimAmountIncludesTax": null,
    "ClaimAmountIncludesTaxCode": null,
    "TransactionSalesperson": null,
    "TransactionSalespersonId": null,
    "CreatedBy": "channel_user",
    "CreationDate": "2023-05-11T06:33:55+00:00",
    "LastUpdateDate": "2023-05-11T06:33:55.967+00:00",
    "LastUpdatedBy": "channel_user",
    "ScheduledProcessNumber": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576187996",
            "name": "channelCustomerMassClaimActions",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576187996",
            "name": "channelCustomerMassClaimActions",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576187996/child/DFF",
            "name": "DFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576187996/child/attachments",
            "name": "attachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576187996/child/claims",
            "name": "claims",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576187996/child/currencyTotals",
            "name": "currencyTotals",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576187996/child/notes",
            "name": "notes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerMassClaimActions/300100576187996/child/settlementLines",
            "name": "settlementLines",
            "kind": "collection"
        }

Back to Top