Get one customer claim
get
/fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}
Request
Path Parameters
-
ClaimId(required): integer(int64)
Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : channelCustomerClaims-item-response
Type:
Show Source
object
-
AccountedAmount: number
Read Only:
true
Amount claimed in the functional currency. -
AccountedAmountRemaining: number
Read Only:
true
Amount remaining in the functional currency. -
AccountedResolvedAmount: number
Read Only:
true
Value that indicates the resolved amount in the functional currency. -
AccountedSplitAmount: number
Read Only:
true
Amount that's carried over to the child claim in the functional currency. -
AccountingDate: string
(date)
Read Only:
true
Date when the claim is accounted. -
Age: integer
Read Only:
true
Number that identifies the age of the claim. -
Amount: number
Amount claimed in the claim currency.
-
AmountRemaining: number
Read Only:
true
Amount remaining in the claim's currency. -
AppliedExistingTransactionsTotal: number
Read Only:
true
Value that identifies the sum of the applied existing transactions amount. -
ApprovedBy: string
Read Only:
true
User who approved the claim. -
ApprovedById: integer
(int64)
Read Only:
true
Value that uniquely identifies the user who approved the claim. -
ApprovedDate: string
(date)
Read Only:
true
Date when the user approved the claim. -
associations: array
Associations
Title:
Associations
The Associations resource manages accrual associations of a claim. -
attachments: array
Attachments
Title:
Attachments
The Attachments resource is used to view, create, and update attachments. -
BillToAccountId: integer
(int64)
Value that uniquely identifies the bill-to customer account.
-
BillToAccountNumber: string
Number of the bill-to customer account.
-
BillToContact: string
Name of the bill-to customer account's contact.
-
BillToContactId: integer
(int64)
Value that uniquely represents the bill-to customer account's contact.
-
BillToCustomer: string
Read Only:
true
Name of the bill-to customer account. -
BillToSite: string
Name of the bill-to customer account site.
-
BillToSiteAddress: string
Read Only:
true
Address of the bill-to customer account site. -
BillToSiteId: integer
(int64)
Value that uniquely identifies the bill-to customer account site.
-
Broker: string
Maximum Length:
255
Name of the broker. -
BrokerId: integer
(int64)
Value that uniquely identifies the broker.
-
BusinessUnit: string
Name of the business unit.
-
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
ChildClaim: string
Read Only:
true
Number of the child claim created. -
ChildClaimId: integer
Read Only:
true
Value that uniquely identifies the child claim. -
ClaimDate: string
(date)
Date when a claim is created.
-
ClaimId: integer
(int64)
Read Only:
true
Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim. -
ClaimNumber: string
Number that indicates the customer claim.
-
ClaimOwner: string
Name of the person who owns the channel claim.
-
ClaimOwnerId: integer
(int64)
Value that uniquely identifies the person who owns the channel claim.
-
ClaimOwnerPersonNumber: string
Maximum Length:
255
Number that uniquely identifies the person who owns the channel claim. -
ClaimReason: string
Reason for creating the claim.
-
ClaimReasonId: integer
(int64)
Value that uniquely identifies the reason to create the claim.
-
ClaimSalesperson: string
Maximum Length:
255
Name of the salesperson associated with the claim. -
ClaimSalespersonId: integer
(int64)
Value that indicates the claim salesperson's number.
-
ClaimSalespersonNumber: integer
Value that uniquely identifies the claim's salesperson.
-
ClaimSource: string
Read Only:
true
Name of the claim sources. -
ClaimSourceCode: string
Read Only:
true
Abbreviation that identifies the claim sources. -
ClaimType: string
The type of claim.
-
ClaimTypeId: integer
(int64)
Value that uniquely identifies the type of claim.
-
CommentsForApprovers: string
Maximum Length:
4000
Comments submitted to provide additional information to approvers. -
ConversionDate: string
(date)
Date when the amount is converted.
-
ConversionRate: number
Value that indicates the conversion rate defined in the general ledger.
-
ConversionRateType: string
Maximum Length:
30
Name of the conversion type defined in the general ledger. -
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. -
Currency: string
Name of the currency used for the channel claim.
-
CurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the currency used for the channel claim. -
CustomerReason: string
Maximum Length:
150
Reason provided by the customer to create the claim. -
CustomerReference: string
Maximum Length:
50
Number that identifies the reference details passed by the customer. -
CustomerReferenceDate: string
(date)
Date of the customer reference document.
-
DFF: array
Descriptive Flexfields for Channel Customer Claims
Title:
Descriptive Flexfields for Channel Customer Claims
The Descriptive Flexfields for Channel Customer Claims resource manages additional details for a claim. -
EligibleForWriteOffFlag: boolean
Read Only:
true
Contains one of the following values: true or false. If true, then the deduction is under the threshold limit and can be written off. If false, then the deduction is not under the threshold limit. This attribute does not have a default value. -
FunctionalCurrency: string
Read Only:
true
Value that indicates the functional currency. -
FunctionalCurrencyCode: string
Read Only:
true
Abbreviation that identifies the functional currency. -
InvoiceAmount: number
Read Only:
true
Amount of the invoice. -
InvoiceCurrency: string
Read Only:
true
Maximum Length:255
Name of the receipt currency. -
InvoiceCurrencyCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the invoice currency. -
InvoiceDate: string
(date)
Read Only:
true
Date when the invoice is created. -
InvoiceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the invoice. -
InvoiceNumber: string
Read Only:
true
Maximum Length:30
Invoice number. -
InvoiceSalesperson: string
Read Only:
true
Maximum Length:255
Name of the salesperson associated with the invoice. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassSettlementNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the mass settlement. -
notes: array
Notes
Title:
Notes
The Notes resource captures comments, information, or instructions for a claim. -
ParentClaim: string
Read Only:
true
Number that identifies the parent claim. -
ParentClaimId: integer
Read Only:
true
Value that uniquely identifies the parent claim. -
ReceiptAmount: number
Read Only:
true
Amount of the receipt. -
ReceiptApplicationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the application line in the receipt. -
ReceiptCurrency: string
Read Only:
true
Maximum Length:255
Name of the currency in the receipt. -
ReceiptCurrencyCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the receipt currency. -
ReceiptDate: string
(date)
Read Only:
true
Date when the receipt is created. -
receiptDFF: array
Descriptive Flexfields of Receipt Application Line
Title:
Descriptive Flexfields of Receipt Application Line
The Descriptive Flexfields of Receipt Application Line resource manages the receipt application line descriptive flexfields for deductions and overpayment. -
ReceiptId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receipt. -
ReceiptNumber: string
Read Only:
true
Maximum Length:30
Number of the receipt. -
ReceiptReference: string
Read Only:
true
Maximum Length:255
Reference provided in the receipt. -
RejectedBy: string
Read Only:
true
User who rejected the claim. -
RejectedById: integer
(int64)
Read Only:
true
Value that uniquely identifies the user who rejected the claim. -
RejectedDate: string
(date)
Read Only:
true
Date when the user rejected the claim. -
ResolvedAmount: number
Read Only:
true
Value that indicates the resolved amount. -
ResolvedBy: string
Read Only:
true
User who submitted the claim for approval. -
ResolvedDate: string
(date)
Read Only:
true
Date when the claim was resolved and submitted for approval. -
SettlementDate: string
(date)
Read Only:
true
Date when the claim moves to settled status. -
settlementLines: array
Settlement Lines
Title:
Settlement Lines
The Settlement Lines resource manages a set of transaction lines that's used to create settlement artifacts such as credit memos in Receivables. -
settlementMethods: array
Settlement Methods
Title:
Settlement Methods
The Settlement Methods resource manages the settlement method that's used to settle a claim. -
SettlementType: string
Maximum Length:
255
Name of the settlement type. -
SettlementTypeCode: string
Maximum Length:
255
Abbreviation that identifies the settlement type selected to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_CUST_CLAIM_RESOL_TYPE. -
ShipToCustomer: string
Name of the ship-to customer.
-
ShipToCustomerId: integer
(int64)
Value that uniquely identifies the ship-to customer.
-
ShipToCustomerSite: string
Name of the ship-to customer site.
-
ShipToCustomerSiteAddress: string
Read Only:
true
Address of the ship-to customer site. -
ShipToCustomerSiteId: integer
(int64)
Value that uniquely identifies the ship-to customer site.
-
SourceClaimNumber: string
Maximum Length:
240
Number that indicates the caim number in the source system. -
SourceClaimSystem: string
Maximum Length:
240
Value that indicates the source sytem from where the claim is interefaced. -
SourceMapId: integer
(int64)
Read Only:
true
Value that uniquely identifies the claim source map assigned to the claim. -
SplitAmount: number
Read Only:
true
Amount that's carried over to the child claim. -
Status: string
Status of the channel claim.
-
StatusId: integer
(int64)
Value that uniquely identifies the status of the channel claim.
-
SystemStatus: string
Read Only:
true
System status of the channel claim. -
SystemStatusCode: string
Read Only:
true
Abbreviation that identifies the system status of the claim. -
TotalAssociatedAmount: number
Read Only:
true
Value that identifies the association amount total in claim currency.
Nested Schema : Associations
Type:
array
Title:
Associations
The Associations resource manages accrual associations of a claim.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Descriptive Flexfields for Channel Customer Claims
Type:
array
Title:
Descriptive Flexfields for Channel Customer Claims
The Descriptive Flexfields for Channel Customer Claims resource manages additional details for a claim.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The Notes resource captures comments, information, or instructions for a claim.
Show Source
Nested Schema : Descriptive Flexfields of Receipt Application Line
Type:
array
Title:
Descriptive Flexfields of Receipt Application Line
The Descriptive Flexfields of Receipt Application Line resource manages the receipt application line descriptive flexfields for deductions and overpayment.
Show Source
Nested Schema : Settlement Lines
Type:
array
Title:
Settlement Lines
The Settlement Lines resource manages a set of transaction lines that's used to create settlement artifacts such as credit memos in Receivables.
Show Source
Nested Schema : Settlement Methods
Type:
array
Title:
Settlement Methods
The Settlement Methods resource manages the settlement method that's used to settle a claim.
Show Source
Nested Schema : channelCustomerClaims-associations-item-response
Type:
Show Source
object
-
AccrueToAccountId: integer
(int64)
Value that uniquely identifies the customer account.
-
AccrueToAccountNumber: string
Maximum Length:
255
Bill to account number used for the association. -
AccrueToCustomer: string
Maximum Length:
255
Name of the bill to customer used for the association. -
AssociatedAmountInClaimCurrency: number
Association amount in claim currency.
-
AssociatedAmountInFunctionalCurrency: number
Read Only:
true
Association amount in functional currency. -
AssociatedAmountInTransactionCurrency: number
Read Only:
true
Association amount in program currency. -
AssociationId: integer
(int64)
Value that uniquely identifies the claim association.
-
ClaimId: integer
(int64)
Read Only:
true
Value that uniquely identifies the claim. -
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. -
InvoiceNumber: string
Maximum Length:
50
Number that indicates the invoice. -
Item: string
Maximum Length:
255
Name of the item used for the association. -
ItemDescription: string
Read Only:
true
Maximum Length:255
Description of the item used for the association. -
ItemId: integer
(int64)
Value that uniquely identifies the 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. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Program: string
Maximum Length:
255
Name of the program used for the association. -
ProgramId: integer
(int64)
Value that uniquely identifies the customer program.
-
ProgramType: string
Read Only:
true
Maximum Length:255
Name of the program type used for the association. -
ProgramTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the program type used for the association. -
PromotionCode: string
Maximum Length:
255
Name of the promotion code used for the association. -
SearchAccrualsBeforeDate: string
(date)
Search parameter for finding accruals before a specified date.
-
SearchAssociationType: string
Maximum Length:
255
Search parameter for the association type for accruals. -
SearchAssociationTypeCode: string
Maximum Length:
30
Search parameter for the association type code for accruals. -
SearchCalendarYear: string
Maximum Length:
30
Search parameter for the calendar year for accruals. -
SearchExcludeZeroBalancesFlag: boolean
Maximum Length:
1
Search parameter for excluding zero-balance accruals. -
SearchInvoiceNumber: string
Maximum Length:
50
Search parameter for accruals based on an invoice number. -
SearchItem: string
Maximum Length:
255
Item number search parameter for accruals. -
SearchItemId: integer
(int64)
Item ID search parameter for accruals.
-
SearchMatchingLevel: string
Maximum Length:
255
Matching level search parameter for accruals. -
SearchMatchingLevelCode: string
Maximum Length:
30
Matching level code search parameter for accruals. -
SearchProgram: string
Maximum Length:
255
Program name search parameter for accruals. -
SearchProgramId: integer
(int64)
Program ID search parameter for accruals.
-
SearchProgramType: string
Maximum Length:
255
Program type search parameter for accruals. -
SearchProgramTypeId: integer
(int64)
Program type ID search parameter for accruals.
-
SearchPromotionCode: string
Maximum Length:
255
Promotion code search parameter for accruals. -
SearchRelatedCustomerAccountId: integer
(int64)
Search parameter for the related customer account ID for accruals.
-
SearchRelatedCustomerAccountNumber: string
Maximum Length:
255
Search parameter for the related customer account number for accruals. -
SearchShowActiveProgramsFlag: boolean
Maximum Length:
1
Search parameters for displaying active program accruals. -
TransactionCurrency: string
Read Only:
true
Maximum Length:255
Transaction currency used for the association. -
TransactionCurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the transaction currency.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : channelCustomerClaims-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the person who uploaded the image. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Code indicating the type of data in the attachment. For example, FILE, WEB_PAGE, or TEXT. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Current version number of the attachment. -
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
Code indicating the type of error, 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
Date when the contents in the attachment expire. -
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
URL of the attachment. -
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 of the person who last updated the image. -
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
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelCustomerClaims-DFF-item-response
Type:
Show Source
object
-
__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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelCustomerClaims-notes-item-response
Type:
Show Source
object
-
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 access 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 of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
Unique identifier of the note. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30
Alternate unique identifier of the note. A user key that is system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
Title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
Column which stores the note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
Note type 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
Source object code for the source object as defined in the OBJECTS metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
Unique identifier of the parent source object associated to 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 to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelCustomerClaims-receiptDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Read Only:true
Maximum Length:30
Context name for the receivable application descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReceivableApplicationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receipt application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelCustomerClaims-settlementLines-item-response
Type:
Show Source
object
-
Amount: number
Value that indicates the amount on the claim line.
-
ClaimId: integer
(int64)
Read Only:
true
Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim. -
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
Name of the item in the inventory.
-
ItemId: integer
(int64)
Value that uniquely identifies the 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. -
LineNumber: number
Number that indicates the claim line.
-
LineType: string
Name of the transaction line type.
-
LineTypeCode: string
Maximum Length:
20
Abbreviation that identifies the transaction line type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemoLine: string
Name of the memo line.
-
MemoLineId: integer
(int64)
Value that uniquely identifies the memo line.
-
ProgramCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the program code associated with the settlement line. -
ProgramId: integer
Read Only:
true
Value that uniquely identifies the program associated with the settlement line. -
ProgramName: string
Read Only:
true
Maximum Length:255
Name of the program associated with the settlement line. -
Quantity: number
Value that indicates the quantity on the claim line.
-
SettlementLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the claim line created in the application. -
UnitOfMeasure: string
Name of the unit of measure.
-
UnitOfMeasureCode: string
Maximum Length:
3
Abbreviation for the unit of measure code. -
UnitPrice: number
Value that indicates the unit price for the selected item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelCustomerClaims-settlementMethods-item-response
Type:
Show Source
object
-
ChargebackReason: string
Maximum Length:
255
Reason for the chargeback. -
ChargebackReasonCode: string
Maximum Length:
30
Abbreviation that identifies the chargeback reason. -
ChargebackTransactionType: string
Maximum Length:
255
Name of the transaction type. -
ChargebackTransactionTypeId: integer
(int64)
Value that uniquely identifies the transaction type.
-
ClaimAmountIncludesTax: string
Maximum Length:
255
Value that indicates if the claim amount includes tax. -
ClaimAmountIncludesTaxCode: string
Maximum Length:
255
Abbreviation that indicates if the claim amount includes tax. -
ClaimId: integer
(int64)
Read Only:
true
Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim. -
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. -
CreditMemoReason: string
Reason for the credit memo.
-
CreditMemoReasonCode: string
Maximum Length:
30
Abbreviation that identifies the credit memo reason. -
CreditMemoTransactionType: string
Name of the transaction type.
-
CreditMemoTransactionTypeSequenceId: integer
(int64)
Value that uniquely identifies the transaction type.
-
InvoiceTransactionType: string
Maximum Length:
255
Name of the transaction type. -
InvoiceTransactionTypeId: integer
(int64)
Value that uniquely identifies the transaction type.
-
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumSettlementLineNumber: number
Read Only:
true
Value that indicates the maximum line number of settlement lines. -
NettingAmount: number
Amount of the open transaction that's used for settlement.
-
OpenTransactionId: integer
(int64)
Value that identifies the credit memo, deduction, or overpayment.
-
OpenTransactionNumber: string
Maximum Length:
30
Number that identifies the credit memo, deduction, or overpayment. -
OverrideTransactionDate: string
(date)
Date that's used to create the credit memo if it's present.
-
ReceivablesActivityForWriteOff: string
Maximum Length:
255
Name of the receivables activity for receipt write-off. -
ReceivablesActivityForWriteOffId: integer
(int64)
Value that uniquely identifies the receivables activity for receipt write-off.
-
SalesPerson: string
Name of the salesperson.
-
SalesPersonId: integer
Value that uniquely identifies the salesperson.
-
SalesPersonNumber: string
Value that indicates salesperson's number.
-
SettlementComments: string
Maximum Length:
2000
Comments that provide additional information about the settlement. -
settlementDocuments: array
Settlement Documents
Title:
Settlement Documents
The Settlement Documents resource manages the artifacts for each settlement method used to confirm the settlement of a claim. -
SettlementLinesTotalAmount: number
Read Only:
true
Total of credit memo or invoice lines. -
SettlementMethod: string
Method of payment used to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_METHOD.
-
SettlementMethodCode: string
Maximum Length:
30
Abbreviation that identifies the payment methods used to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_METHOD. -
SettlementMethodId: integer
(int64)
Read Only:
true
Value that uniquely identifies the settlement method. -
Supplier: string
Maximum Length:
255
Name of the supplier. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierNumber: string
Maximum Length:
255
Number that identifies the supplier. -
SupplierSite: string
Maximum Length:
255
Name of the supplier site. -
SupplierSiteAddress: string
Read Only:
true
Maximum Length:255
Address of the supplier site. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
TransactionAccountingDate: string
(date)
Value that specifies the claim accounting date if it's present.
-
WriteOffReason: string
Maximum Length:
255
Reason for the write-off. -
WriteOffReasonCode: string
Maximum Length:
30
Abbreviation that identifies the reason for the write-off.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Settlement Documents
Type:
array
Title:
Settlement Documents
The Settlement Documents resource manages the artifacts for each settlement method used to confirm the settlement of a claim.
Show Source
Nested Schema : channelCustomerClaims-settlementMethods-settlementDocuments-item-response
Type:
Show Source
object
-
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. -
Details: string
Read Only:
true
Maximum Length:255
Details of the settlement method selected. -
InstrumentAmount: number
Amount settled via the instrument.
-
InstrumentBillToAccountId: integer
(int64)
Read Only:
true
Value that uniquely identifies the bill-to customer account for which the instrument was created. -
InstrumentBillToAccountNumber: string
Read Only:
true
Maximum Length:255
Number of the bill-to customer account for which the instrument was created. -
InstrumentBillToCustomer: string
Read Only:
true
Maximum Length:255
Name of the bill-to customer for which the instrument was created. -
InstrumentBillToSite: string
Read Only:
true
Maximum Length:255
Name of the bill-to customer account site for which the instrument was created. -
InstrumentBillToSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the bill-to customer account site for which the instrument was created. -
InstrumentDate: string
(date)
Date when the settlement instrument was created.
-
InstrumentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the settlement instrument. -
InstrumentNumber: string
Maximum Length:
30
Number of the instrument created upon settlement. -
InstrumentStatus: string
Maximum Length:
30
Status of the instrument. -
InstrumentSupplier: string
Maximum Length:
255
Name of the supplier for which the instrument was created. -
InstrumentSupplierId: integer
(int64)
Value that uniquely identifies the supplier for which the instrument was created.
-
InstrumentSupplierNumber: string
Maximum Length:
255
Number of the supplier for which the instrument was created. -
InstrumentSupplierSite: string
Maximum Length:
255
Site name of the supplier for which the instrument was created. -
InstrumentSupplierSiteAddress: string
Read Only:
true
Maximum Length:255
Site address of the supplier for which the instrument was created. -
InstrumentSupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site for which the instrument was created.
-
InstrumentTax: number
Tax amount for the instrument.
-
InstrumentType: string
Name of the instrument created upon settlement.
-
InstrumentTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the type of the instrument. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalAmount: number
Read Only:
true
Value that indicates the original claim amount. -
payments: array
Payments
Title:
Payments
A sum of money paid, for example, by check or credit memo to settle a claim, which can be viewed and updated. -
SettlementDocumentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the settlement document. -
SettlementMethod: string
Read Only:
true
Method of payment used to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_METHOD. -
SettlementMethodCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the payment methods used to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_METHOD. -
SettlementmethodId: integer
(int64)
Read Only:
true
Value that uniquely identifies the settlement method. -
ThirdPartyInstrumentPayeeName: string
Maximum Length:
360
Name of the third party payee for which the instrument was created.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Payments
Type:
array
Title:
Payments
A sum of money paid, for example, by check or credit memo to settle a claim, which can be viewed and updated.
Show Source
Nested Schema : channelCustomerClaims-settlementMethods-settlementDocuments-payments-item-response
Type:
Show Source
object
-
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. -
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. -
PayeeParty: string
Maximum Length:
255
Party who received the payment. -
PayeePartyId: integer
(int64)
Value that uniquely identifies the party that received the payment.
-
PayeePartySite: string
Maximum Length:
255
Party site that received the payment. -
PayeePartySiteId: integer
(int64)
Value that uniquely identifies the party site that received the payment.
-
PayeeSupplier: string
Maximum Length:
255
Supplier who received the payment. -
PayeeSupplierId: integer
(int64)
Value that uniquely identifies the supplier who received the payment.
-
PayeeSupplierNumber: string
Maximum Length:
255
Number of the supplier who received the payment. -
PayeeSupplierSite: string
Maximum Length:
255
Supplier site that received the payment. -
PayeeSupplierSiteAddress: string
Read Only:
true
Maximum Length:255
Site address of the supplier for which the payment was created. -
PayeeSupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site that received the payment.
-
PaymentAmount: number
Amount of the payment.
-
PaymentDate: string
(date)
Date when the payment was created.
-
PaymentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the payment. -
PaymentMethod: string
Maximum Length:
30
Name of the payment created on settlement. -
PaymentNumber: string
Maximum Length:
30
Number of the payment created on settlement. -
PaymentStatus: string
Maximum Length:
30
Status of the payment. -
SettlementDocumentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the settlement document. -
ThirdPartyPayeeName: string
Maximum Length:
360
Name of the third party payee for which the payment was created.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- ClaimId:
$request.path.ClaimId
The Descriptive Flexfields for Channel Customer Claims resource manages additional details for a claim. - ClaimId:
- associations
-
Parameters:
- ClaimId:
$request.path.ClaimId
The Associations resource manages accrual associations of a claim. - ClaimId:
- attachments
-
Parameters:
- ClaimId:
$request.path.ClaimId
The Attachments resource is used to view, create, and update attachments. - ClaimId:
- cancel
-
Parameters:
- ClaimId:
$request.path.ClaimId
Action to cancel a manual claim. - ClaimId:
- notes
-
Parameters:
- ClaimId:
$request.path.ClaimId
The Notes resource captures comments, information, or instructions for a claim. - ClaimId:
- receiptDFF
-
Parameters:
- ClaimId:
$request.path.ClaimId
The Descriptive Flexfields of Receipt Application Line resource manages the receipt application line descriptive flexfields for deductions and overpayment. - ClaimId:
- reopenCustom
-
Parameters:
- ClaimId:
$request.path.ClaimId
Action to reopen a claim with custom settlement method. - ClaimId:
- settle
-
Parameters:
- ClaimId:
$request.path.ClaimId
Action to settle a claim. - ClaimId:
- settleCustom
-
Parameters:
- ClaimId:
$request.path.ClaimId
Action to settle a claim with custom settlement method. - ClaimId:
- settlementLines
-
Parameters:
- ClaimId:
$request.path.ClaimId
The Settlement Lines resource manages a set of transaction lines that's used to create settlement artifacts such as credit memos in Receivables. - ClaimId:
- settlementMethods
-
Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/settlementMethodsParameters:
- ClaimId:
$request.path.ClaimId
The Settlement Methods resource manages the settlement method that's used to settle a claim. - ClaimId:
Examples
This example describes how to get one customer claim.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "server:port/fscmRestApi/resources/latest/channelCustomerClaims/300100544961161"
Example Response Body
The following shows an example of the response body in JSON format.
"{ ""ClaimId"": 300100544961161, ""ClaimNumber"": ""CLM9003"", ""ClaimSource"": ""Manual Claim"", ""ClaimSourceCode"": ""CLAIM"", ""BusinessUnit"": ""Vision Operations"", ""BusinessUnitId"": 204, ""Amount"": 1800, ""AccountedAmount"": 1800, ""Currency"": ""US Dollar"", ""CurrencyCode"": ""USD"", ""FunctionalCurrency"": ""US Dollar"", ""FunctionalCurrencyCode"": ""USD"", ""BillToCustomer"": ""CDS, Inc"", ""BillToAccountNumber"": ""1140"", ""BillToAccountId"": 1287, ""BillToSite"": ""Pittsburgh (OPS)"", ""BillToSiteId"": 1337, ""BillToSiteAddress"": ""131 Commercial Drive Suite 200 Pittsburgh, PA 15122 United States"", ""BillToContact"": ""Stephen Etter"", ""BillToContactId"": 6094, ""ShipToCustomer"": ""CDS GROUP INC"", ""ShipToCustomerId"": 800995, ""ShipToCustomerSite"": ""244264"", ""ShipToCustomerSiteId"": 372640, ""ShipToCustomerSiteAddress"": ""404 S FIGUEROA ST"", ""ClaimDate"": ""2021-04-10"", ""Age"": 60, ""ClaimType"": ""Unknown"", ""ClaimTypeId"": 300100205262731, ""ClaimReason"": ""Shipping"", ""ClaimReasonId"": 300100205165987, ""CustomerReference"": null, ""CustomerReason"": null, ""Status"": ""Canceled"", ""StatusId"": 100100144204810, ""SystemStatus"": ""Canceled"", ""SystemStatusCode"": ""CANCELLED"", ""ClaimOwner"": ""channel_user"", ""ClaimOwnerId"": 300100181693728, ""ConversionRateType"": ""Corporate"", ""ConversionRate"": 1, ""ConversionDate"": ""2021-05-31"", ""ResolvedDate"": null, ""ResolvedBy"": null, ""ResolvedAmount"": null, ""AccountedResolvedAmount"": null, ""ApprovedDate"": null, ""SettlementDate"": null, ""AccountingDate"": ""2021-05-31"", ""ChildClaim"": null, ""ChildClaimId"": null, ""SplitAmount"": null, ""AccountedSplitAmount"": null, ""ParentClaim"": null, ""ParentClaimId"": null, ""CreatedBy"": ""channel_user"", ""CreationDate"": ""2021-05-31T06:18:55+00:00"", ""LastUpdatedBy"": ""channel_user"", ""LastUpdateDate"": ""2021-05-31T06:22:32+00:00"", ""links"": [ { ""rel"": ""self"", ""href"": ""https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100544961161"", ""name"": ""channelCustomerClaims"", ""kind"": ""item"", ""properties"": { ""changeIndicator"": ""ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"" } }, { ""rel"": ""canonical"", ""href"": ""https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100544961161"", ""name"": ""channelCustomerClaims"", ""kind"": ""item"" }, { ""rel"": ""child"", ""href"": ""https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100544961161/child/settlementLines"", ""name"": ""settlementLines"", ""kind"": ""collection"" }, { ""rel"": ""child"", ""href"": ""https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100544961161/child/settlementMethods"", ""name"": ""settlementMethods"", ""kind"": ""collection"" }, { ""rel"": ""action"", ""href"": ""https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100544961161/action/cancel"", ""name"": ""cancel"", ""kind"": ""other"" }, { ""rel"": ""action"", ""href"": ""https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100544961161/action/settle"", ""name"": ""settle"", ""kind"": ""other"" } ] }"