InstrumentAssignments
The instrument assignment resource is used to view, create, and modify a payment instrument assignment.
Columns
| Name | Type | Description |
| PaymentInstrumentAssignmentId [KEY] | Long | Identifier of the payment instrument assignment. |
| PaymentPartyId | Long | Identifier of the external payer or external payee who is the party component of the payment instrument assignment. |
| PaymentInstrumentId | Long | Identifier of the bank account or credit card payment instrument, which is a component of a payment instrument assignment. |
| PaymentFlow | String | Payment flow of funds capture or disbursement transactions within a payment instrument assignment. Values are from the IBY_PAYMENT_FLOW lookup. |
| PaymentInstrumentType | String | Type of payment instrument, which is a component of a payment instrument assignment. Values from the IBY_INSTRUMENT_TYPES lookup include BANKACCOUNT, CREDITCARD, and DEBITCARD. |
| PrimaryIndicator | String | Indicates whether the payment instrument, as a component of a payment instrument assignment, is the primary payment instrument for the payer or payee. A primary payment instrument automatically populates the transactions. |
| StartDate | Date | Date when the relationship between the payment instrument and the payer or payee becomes active within a payment instrument assignment. |
| EndDate | Date | Date when the relationship between the payment instrument and the payer or payee becomes inactive within a payment instrument assignment. |
| MaskedBankAccountNumber | String | MaskedBankAccountNumber of InstrumentAssignments |
| MaskedCreditCardNumber | String | MaskedCreditCardNumber of InstrumentAssignments |
| VendorId | Long | VendorId of InstrumentAssignments |
| PersonId | Long | Person identifier when the external payee is an employee. |
| Intent | String | Purpose of the payment instrument assignment. The value is based on the payment function of the external payee or the external payer. The following are the expected values: PAYABLES_DISB - Supplier, EMPLOYEE_EXP - Person, EMPLOYEE_EXP - Employee, AR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and ADHOC_PAYMENT - Adhoc. |
| Finder | String | Finder of InstrumentAssignments |