Get one customer claim association
get
/fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/associations/{AssociationId}
Request
Path Parameters
-
AssociationId(required): integer(int64)
Value that uniquely identifies the claim association.
-
ClaimId(required): integer(int64)
Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(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-associations-item-response
Type:
Show Source
object
-
AccrueToAccountId: integer
(int64)
Value that uniquely identifies the customer account.
-
AccrueToAccountNumber: string
Maximum Length:
255
Bill to account number used for the association. -
AccrueToCustomer: string
Maximum Length:
255
Name of the bill to customer used for the association. -
AssociatedAmountInClaimCurrency: number
Association amount in claim currency.
-
AssociatedAmountInFunctionalCurrency: number
Read Only:
true
Association amount in functional currency. -
AssociatedAmountInTransactionCurrency: number
Read Only:
true
Association amount in program currency. -
AssociationId: integer
(int64)
Value that uniquely identifies the claim association.
-
ClaimId: integer
(int64)
Read Only:
true
Value that uniquely identifies the claim. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
InvoiceNumber: string
Maximum Length:
50
Number that indicates the invoice. -
Item: string
Maximum Length:
255
Name of the item used for the association. -
ItemDescription: string
Read Only:
true
Maximum Length:255
Description of the item used for the association. -
ItemId: integer
(int64)
Value that uniquely identifies the item.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Program: string
Maximum Length:
255
Name of the program used for the association. -
ProgramId: integer
(int64)
Value that uniquely identifies the customer program.
-
ProgramType: string
Read Only:
true
Maximum Length:255
Name of the program type used for the association. -
ProgramTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the program type used for the association. -
PromotionCode: string
Maximum Length:
255
Name of the promotion code used for the association. -
SearchAccrualsBeforeDate: string
(date)
Search parameter for finding accruals before a specified date.
-
SearchAssociationType: string
Maximum Length:
255
Search parameter for the association type for accruals. -
SearchAssociationTypeCode: string
Maximum Length:
30
Search parameter for the association type code for accruals. -
SearchCalendarYear: string
Maximum Length:
30
Search parameter for the calendar year for accruals. -
SearchExcludeZeroBalancesFlag: boolean
Maximum Length:
1
Search parameter for excluding zero-balance accruals. -
SearchInvoiceNumber: string
Maximum Length:
50
Search parameter for accruals based on an invoice number. -
SearchItem: string
Maximum Length:
255
Item number search parameter for accruals. -
SearchItemId: integer
(int64)
Item ID search parameter for accruals.
-
SearchMatchingLevel: string
Maximum Length:
255
Matching level search parameter for accruals. -
SearchMatchingLevelCode: string
Maximum Length:
30
Matching level code search parameter for accruals. -
SearchProgram: string
Maximum Length:
255
Program name search parameter for accruals. -
SearchProgramId: integer
(int64)
Program ID search parameter for accruals.
-
SearchProgramType: string
Maximum Length:
255
Program type search parameter for accruals. -
SearchProgramTypeId: integer
(int64)
Program type ID search parameter for accruals.
-
SearchPromotionCode: string
Maximum Length:
255
Promotion code search parameter for accruals. -
SearchRelatedCustomerAccountId: integer
(int64)
Search parameter for the related customer account ID for accruals.
-
SearchRelatedCustomerAccountNumber: string
Maximum Length:
255
Search parameter for the related customer account number for accruals. -
SearchShowActiveProgramsFlag: boolean
Maximum Length:
1
Search parameters for displaying active program accruals. -
TransactionCurrency: string
Read Only:
true
Maximum Length:255
Transaction currency used for the association. -
TransactionCurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the transaction currency.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.