1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Channel Customer Claims

Get all customer claims

get

/fscmRestApi/resources/11.13.18.05/channelCustomerClaims

Request

Query Parameters
  • 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).
  • 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
  • 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.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AccountedAmount; number; Amount claimed in the functional currency.
    • AccountedResolvedAmount; number; Value that indicates the resolved amount in the functional currency.
    • AccountedSplitAmount; number; Amount that's carried over to the child claim in the functional currency.
    • AccountingDate; string; Date when the claim is accounted.
    • Age; integer; Number that identifies the age of the claim.
    • Amount; number; Amount claimed in the claim currency.
    • ApprovedBy; string; User who approved the claim.
    • ApprovedById; integer; Value that uniquely identifies the user who approved the claim.
    • ApprovedDate; string; Date when the user approved the claim.
    • BillToAccountId; integer; 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; Value that uniquely represents the bill-to customer account's contact.
    • BillToCustomer; string; Name of the bill-to customer account.
    • BillToSite; string; Name of the bill-to customer account site.
    • BillToSiteAddress; string; Address of the bill-to customer account site.
    • BillToSiteId; integer; Value that uniquely identifies the bill-to customer account site.
    • Broker; string; Name of the broker.
    • BrokerId; integer; Value that uniquely identifies the broker.
    • BusinessUnit; string; Name of the business unit.
    • BusinessUnitId; integer; Value that uniquely identifies the business unit.
    • ChildClaim; string; Number of the child claim created.
    • ChildClaimId; integer; Value that uniquely identifies the child claim.
    • ClaimDate; string; Date when a claim is created.
    • ClaimId; integer; 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; 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 for creating the claim.
    • ClaimReasonId; integer; Value that uniquely identifies the reason to create the claim.
    • ClaimSalesperson; string; Name of the salesperson associated with the claim.
    • ClaimSalespersonId; integer; Value that indicates the claim salesperson's number.
    • ClaimSalespersonNumber; integer; Value that uniquely identifies the claim's salesperson.
    • ClaimSource; string; Name of the claim sources.
    • ClaimSourceCode; string; Abbreviation that identifies the claim sources.
    • ClaimType; string; The type of claim.
    • ClaimTypeId; integer; Value that uniquely identifies the type of claim.
    • CommentsForApprovers; string; Comments submitted to provide additional information to approvers.
    • ConversionDate; string; Date when the amount is converted.
    • ConversionRate; number; Value that indicates the conversion rate defined in the general ledger.
    • ConversionRateType; string; Name of the conversion type defined in the general ledger.
    • 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.
    • CustomerReason; string; Reason provided by the customer to create the claim.
    • CustomerReference; string; Number that identifies the reference details passed by the customer.
    • CustomerReferenceDate; string; Date of the customer reference document.
    • EligibleForWriteOffFlag; boolean; 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; Value that indicates the functional currency.
    • FunctionalCurrencyCode; string; Abbreviation that identifies the functional currency.
    • InvoiceAmount; number; Amount of the invoice.
    • InvoiceCurrency; string; Name of the receipt currency.
    • InvoiceCurrencyCode; string; Abbreviation that identifies the invoice currency.
    • InvoiceDate; string; Date when the invoice is created.
    • InvoiceId; integer; Value that uniquely identifies the invoice.
    • InvoiceNumber; string; Invoice number.
    • LastUpdateDate; string; Date and time when the user most recently updated the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • MassSettlementNumber; string; Number that identifies the mass settlement.
    • ParentClaim; string; Number that identifies the parent claim.
    • ParentClaimId; integer; Value that uniquely identifies the parent claim.
    • ReceiptAmount; number; Amount of the receipt.
    • ReceiptCurrency; string; Name of the currency in the receipt.
    • ReceiptCurrencyCode; string; Abbreviation that identifies the receipt currency.
    • ReceiptDate; string; Date when the receipt is created.
    • ReceiptId; integer; Value that uniquely identifies the receipt.
    • ReceiptNumber; string; Number of the receipt.
    • ReceiptReference; string; Reference provided in the receipt.
    • RejectedBy; string; User who rejected the claim.
    • RejectedById; integer; Value that uniquely identifies the user who rejected the claim.
    • RejectedDate; string; Date when the user rejected the claim.
    • ResolvedAmount; number; Value that indicates the resolved amount.
    • ResolvedBy; string; User who submitted the claim for approval.
    • ResolvedDate; string; Date when the claim was resolved and submitted for approval.
    • SettlementDate; string; Date when the claim moves to settled status.
    • SettlementType; string; Name of the settlement type.
    • SettlementTypeCode; 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_CUST_CLAIM_RESOL_TYPE.
    • ShipToCustomer; string; Name of the ship-to customer.
    • ShipToCustomerId; integer; Value that uniquely identifies the ship-to customer.
    • ShipToCustomerSite; string; Name of the ship-to customer site.
    • ShipToCustomerSiteAddress; string; Address of the ship-to customer site.
    • ShipToCustomerSiteId; integer; Value that uniquely identifies the ship-to customer site.
    • SourceClaimNumber; string; Number that indicates the caim number in the source system.
    • SourceClaimSystem; string; Value that indicates the source sytem from where the claim is interefaced.
    • SourceMapId; integer; Value that uniquely identifies the claim source map assigned to the claim.
    • SplitAmount; number; Amount that's carried over to the child claim.
    • Status; string; Status of the channel claim.
    • StatusId; integer; Value that uniquely identifies the status of the channel claim.
    • SystemStatus; string; System status of the channel claim.
    • SystemStatusCode; string; Abbreviation that identifies the system status of the claim.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : channelCustomerClaims
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : channelCustomerClaims-item-response
Type: object
Show Source
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 : 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 : Splits
Type: array
Title: Splits
The splits resource is used to create and view split claims.
Show Source
Nested Schema : channelCustomerClaims-associations-item-response
Type: object
Show Source
Nested Schema : channelCustomerClaims-attachments-item-response
Type: object
Show Source
Nested Schema : channelCustomerClaims-DFF-item-response
Type: object
Show Source
Nested Schema : channelCustomerClaims-notes-item-response
Type: object
Show Source
Nested Schema : channelCustomerClaims-receiptDFF-item-response
Type: object
Show Source
Nested Schema : channelCustomerClaims-settlementLines-item-response
Type: object
Show Source
Nested Schema : channelCustomerClaims-settlementMethods-item-response
Type: object
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: object
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: object
Show Source
Nested Schema : channelCustomerClaims-splits-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all customer claims.

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"

Example Response Body

The following shows an example of the response body in JSON format.

"{
    "items": [
        {
            "ClaimId": 300100542635028,
            "ClaimNumber": "CLM2005",
            "ClaimSource": "Manual Claim",
            "ClaimSourceCode": "CLAIM",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "Amount": 103,
            "AccountedAmount": 103,
            "Currency": "US Dollar",
            "CurrencyCode": "USD",
            "FunctionalCurrency": "US Dollar",
            "FunctionalCurrencyCode": "USD",
            "BillToCustomer": "Hilman and Associates",
            "BillToAccountNumber": "1004",
            "BillToAccountId": 1004,
            "BillToSite": "Tulsa (OPS)",
            "BillToSiteId": 1030,
            "BillToSiteAddress": "1230 East 60th Street South  , OK  United States",
            "BillToContact": null,
            "BillToContactId": null,
            "ShipToCustomer": "Hilman and Associates",
            "ShipToCustomerId": 1004,
            "ShipToCustomerSite": "1030",
            "ShipToCustomerSiteId": 1030,
            "ShipToCustomerSiteAddress": "1230 East 60th Street South",
            "ClaimDate": "2021-06-21",
            "Age": 26,
            "ClaimType": "Unknown",
            "ClaimTypeId": 300100205262731,
            "ClaimReason": "Unknown",
            "ClaimReasonId": 300100205155237,
            "CustomerReference": null,
            "CustomerReason": "sdd",
            "Status": "Open",
            "StatusId": 100100144204818,
            "SystemStatus": "Open",
            "SystemStatusCode": "OPEN",
            "ClaimOwner": "channel_user",
            "ClaimOwnerId": 300100181693728,
            "ConversionRateType": "Corporate",
            "ConversionRate": 1,
            "ConversionDate": "2021-06-21",
            "ResolvedDate": null,
            "ResolvedBy": null,
            "ResolvedAmount": null,
            "AccountedResolvedAmount": null,
            "ApprovedDate": null,
            "SettlementDate": null,
            "AccountingDate": null,
            "ChildClaim": null,
            "ChildClaimId": null,
            "SplitAmount": null,
            "AccountedSplitAmount": null,
            "ParentClaim": null,
            "ParentClaimId": null,
            "CreatedBy": "channel_user",
            "CreationDate": "2021-06-21T22:47:46+00:00",
            "LastUpdatedBy": "channel_user",
            "LastUpdateDate": "2021-06-21T22:47:46.199+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100542635028",
                    "name": "channelCustomerClaims",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100542635028",
                    "name": "channelCustomerClaims",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100542635028/child/settlementLines",
                    "name": "settlementLines",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100542635028/child/settlementMethods",
                    "name": "settlementMethods",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100542635028/action/cancel",
                    "name": "cancel",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100542635028/action/settle",
                    "name": "settle",
                    "kind": "other"
                }
            ]
        }
        
    ],
    "count": 1,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims",
            "name": "channelCustomerClaims",
            "kind": "collection"
        }
    ]
}"
Back to Top