Get all claims
get
/fscmRestApi/resources/11.13.18.05/channelClaims
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds channel claims according to the primary key.
Finder Variables:- ClaimId; integer; Value that uniquely identifies the channel claims.
- PrimaryKey: Finds channel claims according to the primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- Age; integer; Number that identifies the age of the claim.
- Amount; number; Amount claimed in the claim currency.
- AmountInFunctionalCurrency; number; Value that indicates the functional currency amount.
- AmountRemaining; number; Value that indicates the remaining amount.
- AmountRemaningInFunctionalCurrency; number; Value that indicates the remaining amount in the functional currency.
- AmountSettled; number; Value that indicates the settled amount. This attribute is updated after the claim is settled.
- AmountSettledInFunctionalCurrency; number; Value that indicates the settled amount in the functional currency.
- ApprovedBy; string; User who approved the claim internally.
- ApprovedById; integer; Value that uniquely identifies the user who approved the claim internally.
- ApprovedDate; string; Date when the user approved the claim.
- BusinessUnit; string; Name of the business unit associated with the claim.
- BusinessUnitId; integer; Value that uniquely identifies the business unit associated with the claim.
- ClaimDate; string; Date when a claim is created. If no date is entered, the default application date is used.
- ClaimFor; string; Value that indicates for whom the claim is created, such as party, customer account, or supplier.
- ClaimForCode; string; Abbreviation that identifies for whom the claim is created, such as party, customer account, or supplier. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_FOR.
- ClaimId; integer; Value that uniquely identifies the channel claim. It is a primary key that the application generates when it creates the claim.
- ClaimNumber; string; Number that indicates the customer-specified claim. If a value is not specified, the application generates a unique number.
- ClaimOwner; string; Name of the person who owns the channel claim.
- ClaimOwnerId; integer; Value that uniquely identifies the person who owns the channel claim.
- ClaimOwnerPersonNumber; string; Number that uniquely identifies the person who owns the channel claim.
- ClaimReason; string; Reason to create the claim.
- ClaimReasonId; integer; Value that uniquely identifies the reason to create the claim.
- ClaimType; string; Type that enable you to classify claims.
- ClaimTypeId; integer; Value that uniquely identifies the claim type.
- CreatedBy; string; User who created the record.
- CreationDate; string; Date and time when the user created the record.
- Currency; string; Name of the currency used for the channel claim.
- CurrencyCode; string; Abbreviation that identifies the currency used for the channel claim.
- FunctionalCurrency; string; Value that indicates the functional currency.
- FunctionalCurrencyCode; string; Abbreviation that identifies the functional currency.
- LastUpdateDate; string; Date and time when the user most recently updated the record.
- LastUpdatedBy; string; User who most recently updated the record.
- PromotionalFlag; boolean; Contains one of the following values: true or false. If true, then the claim is promotional. If false, then the claim is non-promotional. This attribute does not have a default value.
- Reference; string; Number that identifies the reference details passed by the supplier.
- ReferenceDate; string; Date when the supplier reference was generated..
- ResolvedBy; string; User who submitted the claim for approval.
- SettlementDate; string; Date when the debit memo or invoice is created in payables.
- Status; string; Status of the channel claim.
- StatusId; integer; Value that uniquely identifies the status of the channel claim.
- Supplier; string; Name of the supplier.
- SupplierId; integer; Value that uniquely identifies the supplier.
- SupplierNumber; string; Number that identifies the supplier.
- SupplierSite; string; Name of the supplier site.
- SupplierSiteId; integer; Value that uniquely identifies the supplier site.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : channelClaims
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelClaims-item-response
Type:
Show Source
object
-
Age: integer
Read Only:
true
Number that identifies the age of the claim. -
Amount: number
Read Only:
true
Amount claimed in the claim currency. -
AmountInFunctionalCurrency: number
Read Only:
true
Value that indicates the functional currency amount. -
AmountRemaining: number
Read Only:
true
Value that indicates the remaining amount. -
AmountRemaningInFunctionalCurrency: number
Read Only:
true
Value that indicates the remaining amount in the functional currency. -
AmountSettled: number
Read Only:
true
Value that indicates the settled amount. This attribute is updated after the claim is settled. -
AmountSettledInFunctionalCurrency: number
Read Only:
true
Value that indicates the settled amount in the functional currency. -
ApprovedBy: string
Read Only:
true
User who approved the claim internally. -
ApprovedById: integer
(int64)
Read Only:
true
Value that uniquely identifies the user who approved the claim internally. -
ApprovedDate: string
(date)
Read Only:
true
Date when the user approved the claim. -
associatedAccruals: array
Associated Accruals
Title:
Associated Accruals
The Associated Accruals resource dynamically groups the associated accruals. -
BusinessUnit: string
Read Only:
true
Maximum Length:255
Name of the business unit associated with the claim. -
BusinessUnitId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit associated with the claim. -
ClaimDate: string
(date)
Read Only:
true
Date when a claim is created. If no date is entered, the default application date is used. -
ClaimFor: string
Read Only:
true
Maximum Length:255
Value that indicates for whom the claim is created, such as party, customer account, or supplier. -
ClaimForCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies for whom the claim is created, such as party, customer account, or supplier. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_FOR. -
ClaimId: integer
(int64)
Read Only:
true
Value that uniquely identifies the channel claim. It is a primary key that the application generates when it creates the claim. -
ClaimNumber: string
Read Only:
true
Maximum Length:30
Number that indicates the customer-specified claim. If a value is not specified, the application generates a unique number. -
ClaimOwner: string
Read Only:
true
Maximum Length:255
Name of the person who owns the channel claim. -
ClaimOwnerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the person who owns the channel claim. -
ClaimOwnerPersonNumber: string
Read Only:
true
Maximum Length:255
Number that uniquely identifies the person who owns the channel claim. -
ClaimReason: string
Read Only:
true
Maximum Length:255
Reason to create the claim. -
ClaimReasonId: integer
(int64)
Read Only:
true
Value that uniquely identifies the reason to create the claim. -
ClaimType: string
Read Only:
true
Maximum Length:255
Type that enable you to classify claims. -
ClaimTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the claim type. -
Comments: string
Read Only:
true
Maximum Length:4000
Comments for the claim that provide additional information. -
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
Read Only:
true
Maximum Length:255
Name of the currency used for the channel claim. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the currency used for the channel claim. -
FunctionalCurrency: string
Read Only:
true
Value that indicates the functional currency. -
FunctionalCurrencyCode: string
Read Only:
true
Abbreviation that identifies the functional currency. -
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. -
PromotionalFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the claim is promotional. If false, then the claim is non-promotional. This attribute does not have a default value. -
Reference: string
Read Only:
true
Maximum Length:50
Number that identifies the reference details passed by the supplier. -
ReferenceDate: string
(date)
Read Only:
true
Date when the supplier reference was generated.. -
ResolvedBy: string
Read Only:
true
User who submitted the claim for approval. -
SettlementDate: string
(date)
Read Only:
true
Date when the debit memo or invoice is created in payables. -
settlementDocuments: array
Settlement Documents
Title:
Settlement Documents
The Settlement Documents resource manages the settlement documents or instruments for a claim. -
settlementLines: array
Settlement Lines
Title:
Settlement Lines
The Settlement Lines resource manages the lines that gets interfaced to payables or receivables for settlement. -
Status: string
Read Only:
true
Maximum Length:255
Status of the channel claim. -
StatusId: integer
(int64)
Read Only:
true
Value that uniquely identifies the status of the channel claim. -
Supplier: string
Read Only:
true
Maximum Length:255
Name of the supplier. -
SupplierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier. -
SupplierNumber: string
Read Only:
true
Maximum Length:255
Number that identifies the supplier. -
SupplierSite: string
Read Only:
true
Maximum Length:255
Default Value:SUPPLIER_SITE
Name of the supplier site. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site.
Nested Schema : Associated Accruals
Type:
array
Title:
Associated Accruals
The Associated Accruals resource dynamically groups the associated accruals.
Show Source
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 settlement documents or instruments for a claim.
Show Source
Nested Schema : Settlement Lines
Type:
array
Title:
Settlement Lines
The Settlement Lines resource manages the lines that gets interfaced to payables or receivables for settlement.
Show Source
Nested Schema : channelClaims-associatedAccruals-item-response
Type:
Show Source
object
-
accrualDetails: array
Accrual Details
Title:
Accrual Details
The Accrual Details resource manages the mapping of a claim association to the supporting channel accruals. -
AdjustmentAmountInClaimCurrency: number
Read Only:
true
Value that indicates the adjustment amount in the claim currency. -
AdjustmentAmountInFunctionalCurrency: number
Read Only:
true
Value that indicates the adjustment amount in the functional currency. -
AssociatedAmountInClaimCurrency: number
Read Only:
true
Value that indicates the association amount in the claim currency. -
AssociatedAmountInFunctionalCurrency: number
Read Only:
true
Value that indicates the association amount in the functional currency. -
AssociationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the accrual association created for a claim. -
AssociationType: string
Read Only:
true
Value that indicates the level at which association is performed. For example, Program, Order, Product or Invoice. A list of accepted values is defined in the lookup type ORA_CJM_ASSOCIATION_TYPE. -
AssociationTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the level at which association is performed. For example, Program, Order, Product or Invoice. A list of accepted values is defined in the lookup type ORA_CJM_ASSOCIATION_TYPE. -
ClaimId: integer
(int64)
Read Only:
true
Value that uniquely identifies the claim created in the application. -
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
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. -
Program: string
Read Only:
true
Name of the associated channel program. -
ProgramCode: string
Read Only:
true
Abbreviation that identifies the associated channel program. -
ProgramId: integer
(int64)
Read Only:
true
Value that identifies the associated channel program. -
SalesOrderAmountInClaimCurrency: number
Read Only:
true
Value that indicates the sales order amount in the claim currency. -
SalesOrderAmountInFunctionalCurrency: number
Read Only:
true
Value that indicates the sales order amount in the functional currency. -
Supplier: string
Read Only:
true
Name of the supplier. -
SupplierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier. -
SupplierNumber: string
Read Only:
true
Number that identifies the supplier. -
SupplierSite: string
Read Only:
true
Name of the supplier site. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site.
Nested Schema : Accrual Details
Type:
array
Title:
Accrual Details
The Accrual Details resource manages the mapping of a claim association to the supporting channel accruals.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelClaims-associatedAccruals-accrualDetails-item-response
Type:
Show Source
object
-
AccountingDate: string
(date)
Read Only:
true
Date when the accrual is posted to the general ledger. -
AccrualCreationDate: string
(date)
Read Only:
true
Date when the charge components is created in the case of a direct sales order and the program accrual engine start date in the case of backdated adjustment records. -
AdjustmentComments: string
Read Only:
true
Maximum Length:1000
Comments for the manual adjustment. -
AdjustmentNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the manual adjustment. -
AdjustmentReason: string
Read Only:
true
Maximum Length:120
Name of the adjustment reason. -
AdjustmentReasonCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the adjustment reason. -
AdjustmentReasonId: integer
(int64)
Read Only:
true
Value that uniquely identifies the adjustment reason. -
AdjustmentType: string
Read Only:
true
Maximum Length:120
Name of the adjustment type. -
AdjustmentTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the adjustment type. -
AdjustmentTypeUniqueCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the adjustment type. -
AssociatedAmountInClaimCurrency: number
Read Only:
true
Amount associated with a line in the claim currency. -
AssociatedAmountInFunctionalCurrency: number
Read Only:
true
Amount associated with a line in the functional currency. -
AssociationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the association record. -
BillOfLadingNumber: string
Read Only:
true
Maximum Length:120
Number that identifier the contract of the carrier and receipt for the goods that the carrier agrees to transport from a specific origin address to a specific destination address. -
ClaimLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the claim line record. -
ClaimLineUtilizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the claim line utilization. -
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
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. -
OrderBillToCustomer: string
Read Only:
true
Name of the customer on the sales order. -
OrderBillToCustomerAccountNumber: string
Read Only:
true
Account number on the sales order. -
OrderBillToCustomerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer on the sales order. -
OrderDate: string
(date-time)
Read Only:
true
Date when the sales order is created. -
OrderFulfillLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the fulfillment line. -
OrderFulfillLineNumber: integer
Read Only:
true
Number that identifier the sales order line. -
OrderHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the sales order. -
OrderInvoiceDate: string
(date)
Read Only:
true
Date when the invoice is generated for the sales order. -
OrderInvoiceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the invoice generated for the sales order. -
OrderInvoiceLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the invoice line for the sales order line. -
OrderInvoiceLineNumber: number
Read Only:
true
Number that identifies the invoice line for the fulfillment lines. -
OrderInvoiceNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the invoice for the sales order. -
OrderInvoiceSource: string
Read Only:
true
Value that identifies the source of invoice generated for the sales order. -
OrderItem: string
Read Only:
true
Maximum Length:300
Value that uniquely identifies the item on the sales order. -
OrderItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item in the inventory. -
OrderItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item. -
OrderNumber: string
Read Only:
true
Number that identifier the sales order. -
OrderSourceCode: string
Read Only:
true
Abbreviation that identifies the source of the sales order. -
Program: string
Read Only:
true
Name of the associated channel program. -
ProgramCode: string
Read Only:
true
Abbreviation that identifies the associated channel program. -
ProgramId: integer
(int64)
Read Only:
true
Value that uniquely identifies the associated channel program. -
RequestedAccountingDate: string
(date)
Read Only:
true
User requested accounting date. -
ShipmentDate: string
(date)
Read Only:
true
Date when the sales order was actually shipped. -
ShipmentNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the shipment for the sales order. -
TransactionType: string
Read Only:
true
Type of transaction, such as Accrual, Utilized, or Adjustment record. -
TransactionTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the transaction type. -
UtilizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the associated accrual. -
WaybillNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the waybill or airbill for the shipment.
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 : channelClaims-settlementDocuments-item-response
Type:
Show Source
object
-
ClaimId: integer
(int64)
Read Only:
true
Value that uniquely identifies the claim created in the application. -
ClaimPaymentId: integer
(int64)
Value that uniquely identifies the payment associated with the claim.
-
Comments: string
Read Only:
true
Maximum Length:4000
Comments for the claim that provide additional information. -
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. -
GlDate: string
(date)
Read Only:
true
Date when the claim settlement amount is posted to the general ledger. -
InstrumentAmount: number
Read Only:
true
Value that indicates the payable instrument amount. -
InstrumentCurrency: string
Read Only:
true
Currency of the payable instrument. -
InstrumentCurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the payable instrument currency. -
InstrumentDate: string
(date)
Read Only:
true
Date when the payable instrument is created. -
InstrumentNumber: string
Read Only:
true
Maximum Length:30
Number that indicates the payable instrument. -
InstrumentStatus: string
Read Only:
true
Maximum Length:30
Status of the payable instrument. -
InstrumentType: string
Read Only:
true
Maximum Length:30
Type of payables instrument used for claim settlement. -
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. -
PayablesInvoiceDate: string
(date)
Read Only:
true
Date when the invoice is created in payables. -
PayablesInvoiceNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the invoice generated in payables during claim settlement. -
PayablesInvoiceStatus: string
Read Only:
true
Maximum Length:30
Status of the payable invoice. -
SettledBy: integer
(int64)
Read Only:
true
User who settled the claim. -
SettledDate: string
(date)
Read Only:
true
Date when the claim is settled. -
SettlementDocumentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the settlement document. -
SettlementDocumentType: string
Read Only:
true
Type of settlement document line. This can be a transaction or instrument. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_DOC_TYPE. -
SettlementDocumentTypeCode: string
Maximum Length:
30
Abbreviation that identifies the settlement document line. This can be a transaction or instrument. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_DOC_TYPE. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelClaims-settlementLines-item-response
Type:
Show Source
object
-
accrualDetails: array
Accrual Details
Title:
Accrual Details
The Accrual Details resource manages the mapping of a claim association to the supporting channel accruals. -
AmountInClaimCurrency: number
Read Only:
true
Value that indicates the amount on the claim line. -
AmountInFunctionalCurrency: number
Read Only:
true
Value that indicates the amount on the claim line in the functional currency. -
AssociationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the accrual association. -
ClaimId: integer
(int64)
Read Only:
true
Value that uniquely identifies the claim created in the application. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
Item: string
Read Only:
true
Name of the item in the inventory. -
ItemDescription: string
Read Only:
true
Description of the item in the inventory. -
ItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item. -
ItemLevel: string
Read Only:
true
Level at which discounts are defined. Valid values include Item and All Items. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL. -
ItemLevelCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the level at which discounts are defined. -
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
Read Only:
true
Number that indicates the claim line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SettlementLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the claim line created in the application.
Nested Schema : Accrual Details
Type:
array
Title:
Accrual Details
The Accrual Details resource manages the mapping of a claim association to the supporting channel accruals.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelClaims-settlementLines-accrualDetails-item-response
Type:
Show Source
object
-
AccountingDate: string
(date)
Read Only:
true
Date when the accrual is posted to the general ledger. -
AccrualCreationDate: string
(date)
Read Only:
true
Date when the charge components is created in the case of a direct sales order and the program accrual engine start date in the case of backdated adjustment records. -
AdjustmentComments: string
Read Only:
true
Maximum Length:1000
Comments for the manual adjustment. -
AdjustmentNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the manual adjustment. -
AdjustmentReason: string
Read Only:
true
Maximum Length:120
Name of the adjustment reason. -
AdjustmentReasonCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the adjustment reason. -
AdjustmentReasonId: integer
(int64)
Read Only:
true
Value that uniquely identifies the adjustment reason. -
AdjustmentType: string
Read Only:
true
Maximum Length:120
Name of the adjustment type. -
AdjustmentTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the adjustment type. -
AdjustmentTypeUniqueCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the adjustment type. -
AssociatedAmountInClaimCurrency: number
Read Only:
true
Amount associated with a line in the claim currency. -
AssociatedAmountInFunctionalCurrency: number
Read Only:
true
Amount associated with a line in the functional currency. -
AssociationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the association record. -
BillOfLadingNumber: string
Read Only:
true
Maximum Length:120
Number that identifier the contract of the carrier and receipt for the goods that the carrier agrees to transport from a specific origin address to a specific destination address. -
ClaimLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the claim line record. -
ClaimLineUtilizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the claim line utilization. -
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
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. -
OrderBillToCustomer: string
Read Only:
true
Name of the customer on the sales order. -
OrderBillToCustomerAccountNumber: string
Read Only:
true
Account number on the sales order. -
OrderBillToCustomerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer on the sales order. -
OrderDate: string
(date-time)
Read Only:
true
Date when the sales order is created. -
OrderFulfillLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the fulfillment line. -
OrderFulfillLineNumber: integer
Read Only:
true
Number that identifier the sales order line. -
OrderHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the sales order. -
OrderInvoiceDate: string
(date)
Read Only:
true
Date when the invoice is generated for the sales order. -
OrderInvoiceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the invoice generated for the sales order. -
OrderInvoiceLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the invoice line for the sales order line. -
OrderInvoiceLineNumber: number
Read Only:
true
Number that identifies the invoice line for the fulfillment lines. -
OrderInvoiceNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the invoice for the sales order. -
OrderInvoiceSource: string
Read Only:
true
Value that identifies the source of invoice generated for the sales order. -
OrderItem: string
Read Only:
true
Maximum Length:300
Value that uniquely identifies the item on the sales order. -
OrderItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item in the inventory. -
OrderItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item. -
OrderNumber: string
Read Only:
true
Number that identifier the sales order. -
OrderSourceCode: string
Read Only:
true
Abbreviation that identifies the source of the sales order. -
Program: string
Read Only:
true
Name of the associated channel program. -
ProgramCode: string
Read Only:
true
Abbreviation that identifies the associated channel program. -
ProgramId: integer
(int64)
Read Only:
true
Value that uniquely identifies the associated channel program. -
RequestedAccountingDate: string
(date)
Read Only:
true
User requested accounting date. -
ShipmentDate: string
(date)
Read Only:
true
Date when the sales order was actually shipped. -
ShipmentNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the shipment for the sales order. -
TransactionType: string
Read Only:
true
Type of transaction, such as Accrual, Utilized, or Adjustment record. -
TransactionTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the transaction type. -
UtilizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the associated accrual. -
WaybillNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the waybill or airbill for the shipment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all claims.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/channelClaims"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "BusinessUnit": "Vision Operations", "BusinessUnitId": 204, "ClaimId": 100100135768768, "ClaimNumber": "CLA4073", "ClaimOwner": null, "ClaimOwnerId": null, "Currency": "US Dollar", "CurrencyCode": "USD", "Amount": 3, "ClaimDate": "2020-05-29", "ClaimFor": "Supplier", "ClaimForCode": "SUPPLIER", "Supplier": "CDS, Inc", "SupplierNumber": "5102", "SupplierId": 1178, "SupplierSite": "PITTSBURGH", "SupplierSiteId": 2854, "ClaimType": null, "ClaimTypeId": 300100176953938, "ClaimReason": null, "ClaimReasonId": 300100176954653, "Status": "Open", "StatusId": 300100183528747, "Comments": null, "Reference": null, "ReferenceDate": null, "PromotionalFlag": true, "FunctionalCurrency": "US Dollar", "FunctionalCurrencyCode": "USD", "AmountInFunctionalCurrency": 3, "AmountSettledInFunctionalCurrency": null, "AmountSettled": null, "AmountRemaining": 3, "AmountRemaningInFunctionalCurrency": 3, "Age": 6, "ApprovedById": null, "ApprovedBy": null, "ApprovedDate": null, "SettlementDate": null, "ResolvedBy": null, "CreatedBy": "channel_user", "CreationDate": "2020-05-29T10:06:37.736+00:00", "LastUpdatedBy": "channel_user", "LastUpdateDate": "2020-05-29T10:06:37.736+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelClaims/100100135768768", "name": "channelClaims", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelClaims/100100135768768", "name": "channelClaims", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelClaims/100100135768768/child/associatedAccruals", "name": "associatedAccruals", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelClaims/100100135768768/child/settlementDocuments", "name": "settlementDocuments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelClaims/100100135768768/child/settlementLines", "name": "settlementLines", "kind": "collection" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelClaims", "name": "channelClaims", "kind": "collection" } ] }