Get all applicable instrument assignments
get
/crmRestApi/resources/11.13.18.05/creditCardInstrumentAssignments
Request
Query Parameters
-
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 the applicable instrument assignment with the unique instrument assignment identifier finder.
Finder Variables- InstrAssignmentId; integer; The unique instrument assignment identifier of the quote to contacts used to find instrument assignment.
- creditCardRowFinder Finds the applicable instrument assignments available for the subscriptions.
Finder Variables- Bind_AcctSiteUseId; integer;
- Bind_CustAccountId; integer;
- Bind_InstrumentType; string;
- Bind_PartyId; integer;
- Bind_PayerEquivalency; string;
- Bind_PayerLevel; string;
- Bind_PaymentFunction; string;
- PrimaryKey Finds the applicable instrument assignment with the unique instrument assignment identifier finder.
-
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:- AccountNumber; string; The account number of the applicable instrument assignment.
- AccountSiteUseId; integer; Account site identifier of the applicable instrument assignment.
- AssignmentEndDate; string; The assignment end date of the applicable instrument assignment.
- AssignmentLastUpdate; string; The last update assignment of the applicable instrument assignment.
- AssignmentStartDate; string; The assignment start date of the applicable instrument assignment.
- BICNumber; string; The BIC number of the applicable instrument assignment.
- BankName; string; The bank name of the applicable instrument assignment.
- BankNumber; string; The bank number of the applicable instrument assignment.
- BranchName; string; The branch number of the applicable instrument assignment.
- BranchNumber; string; The branch name of the applicable instrument assignment.
- CardBillingAddressId; integer; The card billing address identifier of the applicable instrument assignment.
- CardExpirydate; string; The card expiry date of the applicable instrument assignment.
- CardFiName; string; The financial institution of the applicable instrument assignment.
- CardHolderName; string; The card holder name of the applicable instrument assignment.
- CardInformationOnlyFlag; boolean; The only card information flag of the applicable instrument assignment.
- CardIssuerAcceptedFlag; boolean; The card issuer accepted flag of the applicable instrument assignment.
- CardIssuerCode; string; The card issuer code of the applicable instrument assignment.
- CardIssuerName; string; The card issuer name of the applicable instrument assignment.
- CardNumber; string; The card number of the applicable instrument assignment.
- CardSingleUseFlag; boolean; Flag that identifies single use of the applicable instrument assignment.
- CreatedBy; string; The user who created the instrument assignment.
- CreationDate; string; The date when instrument assignment was first created.
- CurrencyCode; string; The currency code of the applicable instrument assignment.
- CustomerAccountId; integer; Customer account identifier of the applicable instrument assignment.
- Description; string; The description of the applicable instrument assignment.
- ExternalPayerId; integer; External payer identifier of the applicable instrument assignment.
- InstrAssignmentId; integer; Instrument assignment identifier of the applicable instrument assignment.
- InstrumentId; integer; Unique instrument identifier of the applicable instrument assignment.
- InstrumentType; string; The type of the applicable instrument assignment.
- LastUpdateDate; string; The date when instrument assignment was last updated.
- LastUpdateLogin; string; The last update login of the applicable instrument assignment.
- LastUpdatedBy; string; The user who last updated the instrument assignment.
- ObjectVersionNumber; integer; The version number of the applicable instrument assignment.
- PartyId; integer; Unique party identifier of the applicable instrument assignment.
- PaymentFunction; string; The payment function of the applicable instrument assignment.
- PrimaryFlag; boolean; The primary flag of the applicable instrument assignment.
- PurchasecardSubtype; string; The purchase card subtype of the applicable instrument assignment.
-
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: 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
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 : creditCardInstrumentAssignments-item-response
Type:
Show Source
object
-
AccountNumber: string
Title:
Number
Read Only:true
Maximum Length:100
The account number of the applicable instrument assignment. -
AccountSiteUseId: integer
(int64)
Read Only:
true
Account site identifier of the applicable instrument assignment. -
AssignmentEndDate: string
(date)
Title:
To Date
Read Only:true
The assignment end date of the applicable instrument assignment. -
AssignmentLastUpdate: string
(date)
Read Only:
true
The last update assignment of the applicable instrument assignment. -
AssignmentStartDate: string
(date)
Title:
From Date
Read Only:true
The assignment start date of the applicable instrument assignment. -
BankName: string
Title:
Bank
Read Only:true
Maximum Length:360
The bank name of the applicable instrument assignment. -
BankNumber: string
Read Only:
true
Maximum Length:30
The bank number of the applicable instrument assignment. -
BICNumber: string
Title:
BIC
Read Only:true
The BIC number of the applicable instrument assignment. -
BranchName: string
Title:
Bank Branch Name
Read Only:true
Maximum Length:360
The branch number of the applicable instrument assignment. -
BranchNumber: string
Title:
Bank Branch Number
Read Only:true
Maximum Length:30
The branch name of the applicable instrument assignment. -
CardBillingAddressId: integer
Read Only:
true
The card billing address identifier of the applicable instrument assignment. -
CardExpirydate: string
(date)
Title:
Expiration Date
Read Only:true
The card expiry date of the applicable instrument assignment. -
CardFiName: string
Title:
Financial Institution
Read Only:true
Maximum Length:80
The financial institution of the applicable instrument assignment. -
CardHolderName: string
Title:
Card Holder
Read Only:true
Maximum Length:360
The card holder name of the applicable instrument assignment. -
CardInformationOnlyFlag: boolean
Read Only:
true
Maximum Length:1
The only card information flag of the applicable instrument assignment. -
CardIssuerAcceptedFlag: boolean
Read Only:
true
Maximum Length:1
The card issuer accepted flag of the applicable instrument assignment. -
CardIssuerCode: string
Title:
Card Brand
Read Only:true
Maximum Length:30
The card issuer code of the applicable instrument assignment. -
CardIssuerName: string
Title:
Card Brand
Read Only:true
Maximum Length:100
The card issuer name of the applicable instrument assignment. -
CardNumber: string
Read Only:
true
Maximum Length:30
The card number of the applicable instrument assignment. -
CardSingleUseFlag: boolean
Title:
Single Use
Read Only:true
Maximum Length:1
Flag that identifies single use of the applicable instrument assignment. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the instrument assignment. -
CreationDate: string
(date-time)
Read Only:
true
The date when instrument assignment was first created. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
The currency code of the applicable instrument assignment. -
CustomerAccountId: integer
(int64)
Read Only:
true
Customer account identifier of the applicable instrument assignment. -
Description: string
Read Only:
true
Maximum Length:240
The description of the applicable instrument assignment. -
ExternalPayerId: integer
(int64)
Read Only:
true
External payer identifier of the applicable instrument assignment. -
InstrAssignmentId: integer
(int64)
Read Only:
true
Instrument assignment identifier of the applicable instrument assignment. -
InstrumentId: integer
(int64)
Read Only:
true
Unique instrument identifier of the applicable instrument assignment. -
InstrumentType: string
Read Only:
true
Maximum Length:30
The type of the applicable instrument assignment. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when instrument assignment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the instrument assignment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The last update login of the applicable instrument assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The version number of the applicable instrument assignment. -
PartyId: integer
(int64)
Read Only:
true
Unique party identifier of the applicable instrument assignment. -
PaymentFunction: string
Read Only:
true
Maximum Length:30
The payment function of the applicable instrument assignment. -
PrimaryFlag: boolean
Read Only:
true
Maximum Length:30
The primary flag of the applicable instrument assignment. -
PurchasecardSubtype: string
Title:
Company Card Subtype
Read Only:true
Maximum Length:30
The purchase card subtype of the applicable instrument assignment.
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.