Get all settlement methods
get
/fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/settlementMethods
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 -
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 claim settlement methods according to the primary key.
Finder Variables:- SettlementMethodId; integer; Value that uniquely identifies the channel claim settlement methods
- PrimaryKey: Finds channel claim settlement methods 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:- ChargebackReason; string; Reason for the chargeback.
- ChargebackReasonCode; string; Abbreviation that identifies the chargeback reason.
- ChargebackTransactionType; string; Name of the transaction type.
- ChargebackTransactionTypeId; integer; Value that uniquely identifies the transaction type.
- ClaimAmountIncludesTax; string; Value that indicates if the claim amount includes tax.
- ClaimAmountIncludesTaxCode; string; Abbreviation that indicates if the claim amount includes tax.
- ClaimId; integer; Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim.
- CreatedBy; string; User who created the record.
- CreationDate; string; Date and time when the user created the record.
- CreditMemoReason; string; Reason for the credit memo.
- CreditMemoReasonCode; string; Abbreviation that identifies the credit memo reason.
- CreditMemoTransactionType; string; Name of the transaction type.
- CreditMemoTransactionTypeSequenceId; integer; Value that uniquely identifies the transaction type.
- InvoiceTransactionType; string; Name of the transaction type.
- InvoiceTransactionTypeId; integer; Value that uniquely identifies the transaction type.
- LastUpdateDate; string; Date and time when the user most recently updated the record.
- LastUpdatedBy; string; User who most recently updated the record.
- NettingAmount; number; Amount of the open transaction that's used for settlement.
- OpenTransactionId; integer; Value that identifies the credit memo, deduction, or overpayment.
- OpenTransactionNumber; string; Number that identifies the credit memo, deduction, or overpayment.
- OverrideTransactionDate; string; Date that's used to create the credit memo if it's present.
- ReceivablesActivityForWriteOff; string; Name of the receivables activity for receipt write-off.
- ReceivablesActivityForWriteOffId; integer; 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; Comments that provide additional information about the settlement.
- 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; 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; Value that uniquely identifies the settlement method.
- TransactionAccountingDate; string; Value that specifies the claim accounting date if it's present.
- WriteOffReason; string; Reason for the write-off.
- WriteOffReasonCode; string; Abbreviation that identifies the reason for the write-off.
-
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(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : channelCustomerClaims-settlementMethods
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 : 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. -
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 : 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-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
Read Only:
true
Amount settled via the instrument. -
InstrumentDate: string
(date)
Date when the settlement instrument was created.
-
InstrumentId: integer
(int64)
Value that uniquely identifies the settlement instrument.
-
InstrumentNumber: string
Maximum Length:
30
Number of the instrument created upon settlement. -
InstrumentTax: number
Read Only:
true
Tax amount for the instrument. -
InstrumentType: string
Read Only:
true
Name of the instrument created upon settlement. -
InstrumentTypeCode: string
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. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source