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

Get all claim types

get

/fscmRestApi/resources/11.13.18.05/channelClaimTypes

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 claim types according to the primary key.
      Finder Variables:
      • ClaimTypeId; integer; Value that uniquely identifies the channel claim type.
    • findActiveBuySideClaimTypes: Finds all the active buy-side claim types based on the business unit.
      Finder Variables:
      • BusinessUnitId; string.
      • ClmTypeId; integer; Value of the unique identifier with which a claim type can be fetched irrespective of the effective date check.
      • EffectiveDate; string; Specifies the date to be considered for an effective date check.
    • findActiveSellSideClaimTypes: Finds all the active sell-side claim types based on the business unit.
      Finder Variables:
      • BusinessUnitId; string.
      • ClmTypeId; integer; Value of the unique identifier with which a claim type can be fetched irrespective of the effective date check.
      • EffectiveDate; string; Specifies the date to be considered for an effective date check.
  • 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:
    • BuySideFlag; boolean; Contains one of the following values: true or false. If true, then the claim type will be enabled for the buy-side flows. If false, then the claim type will not be enabled for the buy-side flows. This attribute does not have a default value.
    • ChargebackTransactionType; string; Name that identifies the transaction type for a receivables chargeback. This transaction type is passed to receivables when deductions using this claim type are settled by chargeback.
    • ChargebackTransactionTypeSequenceId; integer; Value that identifies the transaction type for a receivables chargeback. This transaction type is passed to receivables when deductions using this claim type are settled by chargeback.
    • ClaimType; string; Name of the channel claim type.
    • ClaimTypeCode; string; Abbreviation that identifies the channel claim type.
    • ClaimTypeId; integer; Value that uniquely identifies the channel claim type. It is a primary key that the application generates when it creates the claim type.
    • CreditMemoTransactionType; string; Name that identifies the transaction type for a receivables credit memo. This transaction type is passed to receivables when claims or deductions using this claim type are settled by a credit memo.
    • CreditMemoTransactionTypeSequenceId; integer; Value that identifies the transaction type for a receivables credit memo. This transaction type is passed to receivables when claims or deductions using this claim type are settled by a credit memo.
    • InvoiceTransactionType; string; Name that identifies the transaction type for a receivables Invoice. This transaction type is passed to receivables when claims or overpayments using this claim type are settled by an invoice.
    • InvoiceTransactionTypeSequenceId; integer; Value that identifies the transaction type for a receivables Invoice. This transaction type is passed to receivables when claims or overpayments using this claim type are settled by an invoice.
    • SellSideFlag; boolean; Contains one of the following values: true or false. If true, then the claim type will be enabled for the sell-side flows. If false, then the claim type will not be enabled for the sell-side flows. This attribute does not have a default value.
    • SetCode; string; Abbreviation that identifies the reference data set to which channel claim type is assigned to.
    • SetId; integer; Value that uniquely identifies the reference data set to which channel claim type is assigned to.
    • SetName; string; Name of the reference data set to which channel claim type is assigned to.
  • 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 : channelClaimTypes
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : channelClaimTypes-item-response
Type: object
Show Source
  • Business-Unit Level Mappings
    Title: Business-Unit Level Mappings
    The Business-Unit Level Mappings resource manages the business unit level mappings for a claim type within a reference data set.
  • Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the claim type will be enabled for the buy-side flows. If false, then the claim type will not be enabled for the buy-side flows. This attribute does not have a default value.
  • Maximum Length: 255
    Name that identifies the transaction type for a receivables chargeback. This transaction type is passed to receivables when deductions using this claim type are settled by chargeback.
  • Value that identifies the transaction type for a receivables chargeback. This transaction type is passed to receivables when deductions using this claim type are settled by chargeback.
  • Maximum Length: 120
    Name of the channel claim type.
  • Maximum Length: 30
    Abbreviation that identifies the channel claim type.
  • Read Only: true
    Value that uniquely identifies the channel claim type. It is a primary key that the application generates when it creates the claim type.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • Name that identifies the transaction type for a receivables credit memo. This transaction type is passed to receivables when claims or deductions using this claim type are settled by a credit memo.
  • Value that identifies the transaction type for a receivables credit memo. This transaction type is passed to receivables when claims or deductions using this claim type are settled by a credit memo.
  • Maximum Length: 1000
    Description of the channel claim type.
  • Date when the channel claim type becomes inactive.
  • Maximum Length: 255
    Name that identifies the transaction type for a receivables Invoice. This transaction type is passed to receivables when claims or overpayments using this claim type are settled by an invoice.
  • Value that identifies the transaction type for a receivables Invoice. This transaction type is passed to receivables when claims or overpayments using this claim type are settled by an invoice.
  • Read Only: true
    User who most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    Date and time when the user most recently updated the record.
  • Links
  • Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the claim type will be enabled for the sell-side flows. If false, then the claim type will not be enabled for the sell-side flows. This attribute does not have a default value.
  • Abbreviation that identifies the reference data set to which channel claim type is assigned to.
  • Value that uniquely identifies the reference data set to which channel claim type is assigned to.
  • Name of the reference data set to which channel claim type is assigned to.
  • Date when the channel claim type becomes active.
Nested Schema : Business-Unit Level Mappings
Type: array
Title: Business-Unit Level Mappings
The Business-Unit Level Mappings resource manages the business unit level mappings for a claim type within a reference data set.
Show Source
Nested Schema : channelClaimTypes-businessUnitLevelMappings-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all claim types.

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/channelClaimTypes"

Example Response Body

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

{
	"items": [
	{
		"ClaimTypeId": 300100181565221,
		"ClaimType": "Promotional",
		"Description": "Promotional",
		"SetId": 204,
		"SetName": "Vision Operations Set",
		"SetCode": "Vision Operations 204",
		"StartDate": "2019-08-29",
		"EndDate": "2034-02-18",
		"CreatedBy": "channel_user",
		"CreationDate": "2019-08-29T08:02:36+00:00",
		"LastUpdateDate": "2019-08-29T08:02:36.050+00:00",
		"LastUpdatedBy": "channel_user",
		"ClaimTypeCode": "PROMOTIONAL_CLAIMTYPE",
		"CreditMemoTransactionTypeSequenceId": null,
		"CreditMemoTransactionType": null,
		"InvoiceTransactionTypeSequenceId": null,
		"InvoiceTransactionType": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/channelClaimTypes/300100181565221",
			"name": "channelClaimTypes",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/channelClaimTypes/300100181565221",
			"name": "channelClaimTypes",
			"kind": "item"
		}
		]
	},
	{
		"ClaimTypeId": 300100185728700,
		"ClaimType": "Vendor Claim",
		"Description": "Vendor Claim",
		"SetId": 204,
		"SetName": "Vision Operations Set",
		"SetCode": "Vision Operations 204",
		"StartDate": null,
		"EndDate": null,
		"CreatedBy": "channel_user",
		"CreationDate": "2020-06-02T10:53:30+00:00",
		"LastUpdateDate": "2020-06-02T10:53:30.112+00:00",
		"LastUpdatedBy": "channel_user",
		"ClaimTypeCode": "VENDOR_CLAIM",
		"CreditMemoTransactionTypeSequenceId": null,
		"CreditMemoTransactionType": null,
		"InvoiceTransactionTypeSequenceId": null,
		"InvoiceTransactionType": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/channelClaimTypes/300100185728700",
			"name": "channelClaimTypes",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/channelClaimTypes/300100185728700",
			"name": "channelClaimTypes",
			"kind": "item"
		}
		]
	}
	],
	"count": 2,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/channelClaimTypes",
		"name": "channelClaimTypes",
		"kind": "collection"
	}
	]
}
Back to Top