Get an applicable instrument assignment
get
/crmRestApi/resources/11.13.18.05/creditCardInstrumentAssignments/{creditCardInstrumentAssignmentsUniqID}
Request
Path Parameters
-
creditCardInstrumentAssignmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Credit Card Instrument Assignments resource and used to uniquely identify an instance of Credit Card Instrument Assignments. The client should not generate the hash key value. Instead, the client should query on the Credit Card Instrument Assignments collection resource in order to navigate to a specific instance of Credit Card Instrument Assignments to get the hash key.
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: string
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: string
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 : creditCardInstrumentAssignments-item-response
Type:
Show Source
object-
AccountNumber: string
Title:
NumberRead Only:trueMaximum Length:100The account number of the applicable instrument assignment. -
AccountSiteUseId: integer
(int64)
Read Only:
trueAccount site identifier of the applicable instrument assignment. -
AssignmentEndDate: string
(date)
Title:
To DateRead Only:trueThe assignment end date of the applicable instrument assignment. -
AssignmentLastUpdate: string
(date)
Read Only:
trueThe last update assignment of the applicable instrument assignment. -
AssignmentStartDate: string
(date)
Title:
From DateRead Only:trueThe assignment start date of the applicable instrument assignment. -
BankName: string
Title:
BankRead Only:trueMaximum Length:360The bank name of the applicable instrument assignment. -
BankNumber: string
Read Only:
trueMaximum Length:30The bank number of the applicable instrument assignment. -
BICNumber: string
Title:
BICRead Only:trueThe BIC number of the applicable instrument assignment. -
BranchName: string
Title:
Bank Branch NameRead Only:trueMaximum Length:360The branch number of the applicable instrument assignment. -
BranchNumber: string
Title:
Bank Branch NumberRead Only:trueMaximum Length:30The branch name of the applicable instrument assignment. -
CardBillingAddressId: integer
Read Only:
trueThe card billing address identifier of the applicable instrument assignment. -
CardExpirydate: string
(date)
Title:
Expiration DateRead Only:trueThe card expiry date of the applicable instrument assignment. -
CardFiName: string
Title:
Financial InstitutionRead Only:trueMaximum Length:80The financial institution of the applicable instrument assignment. -
CardHolderName: string
Title:
Card HolderRead Only:trueMaximum Length:360The card holder name of the applicable instrument assignment. -
CardInformationOnlyFlag: boolean
Read Only:
trueMaximum Length:1The only card information flag of the applicable instrument assignment. -
CardIssuerAcceptedFlag: boolean
Read Only:
trueMaximum Length:1The card issuer accepted flag of the applicable instrument assignment. -
CardIssuerCode: string
Title:
Card BrandRead Only:trueMaximum Length:30The card issuer code of the applicable instrument assignment. -
CardIssuerName: string
Title:
Card BrandRead Only:trueMaximum Length:100The card issuer name of the applicable instrument assignment. -
CardNumber: string
Read Only:
trueMaximum Length:30The card number of the applicable instrument assignment. -
CardSingleUseFlag: boolean
Title:
Single UseRead Only:trueMaximum Length:1Flag that identifies single use of the applicable instrument assignment. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the instrument assignment. -
CreationDate: string
(date-time)
Read Only:
trueThe date when instrument assignment was first created. -
CurrencyCode: string
Read Only:
trueMaximum Length:15The currency code of the applicable instrument assignment. -
CustomerAccountId: integer
(int64)
Read Only:
trueCustomer account identifier of the applicable instrument assignment. -
Description: string
Read Only:
trueMaximum Length:240The description of the applicable instrument assignment. -
ExternalPayerId: integer
(int64)
Read Only:
trueExternal payer identifier of the applicable instrument assignment. -
InstrAssignmentId: integer
(int64)
Read Only:
trueInstrument assignment identifier of the applicable instrument assignment. -
InstrumentId: integer
(int64)
Read Only:
trueUnique instrument identifier of the applicable instrument assignment. -
InstrumentType: string
Read Only:
trueMaximum Length:30The type of the applicable instrument assignment. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when instrument assignment was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the instrument assignment. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The last update login of the applicable instrument assignment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
trueThe version number of the applicable instrument assignment. -
PartyId: integer
(int64)
Read Only:
trueUnique party identifier of the applicable instrument assignment. -
PaymentFunction: string
Read Only:
trueMaximum Length:30The payment function of the applicable instrument assignment. -
PrimaryFlag: boolean
Read Only:
trueMaximum Length:30The primary flag of the applicable instrument assignment. -
PurchasecardSubtype: string
Title:
Company Card SubtypeRead Only:trueMaximum Length:30The purchase card subtype of the applicable instrument assignment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.