| | |
|---|
account_holder (optional) | String | The account holder of the retrieved payment preference |
bank_account_number (mandatory on conditionsoptional) | String | The bank account number of the retrieved payment preference | Tip |
|---|
For releases prior CRM.COM R13.1.0, this parameter is optionalFrom CRM.COM R13.1.0 and onwards, this parameter is mandatory if the respective information does not exist in the system and the "sepa" parameter is specified |
payment_preference_identifier
(mandatory) | Identifier | The identifier of the payment preference to be added on account payment preference object. The allowed payment preference identifier fields are the following: | Include Page |
|---|
| payment_preference_identifier |
|---|
| payment_preference_identifier |
|---|
|
|
bank_account_type_identifier (optional) | Identifier
| The identifier of the bank account type to be added on account payment preference object. The allowed bank account type identifier fields are the following: | Include Page |
|---|
| bank_account_type_identifier |
|---|
| bank_account_type_identifier |
|---|
|
|
bank_identifier (optional) | Identifier
| The identifier of the bank to be added on account payment preference object. The allowed bank identifier fields are the following: | Include Page |
|---|
| bank_identifier |
|---|
| bank_identifier |
|---|
|
|
bank_branch_identifier (optional) | Identifier
| The identifier of the bank branch to be added on account payment preference object. The allowed bank branch identifier fields are the following: | Include Page |
|---|
| bank_branch_identifier |
|---|
| bank_branch_identifier |
|---|
|
|
notes (optional) | String | The notes to be added on account payment preference object. | Tip |
|---|
Available from CRM.COM R10.1.0 |
|
payment_medium_identifier (optional) | String | The payment medium identifier to be added on account payment preference object. | Tip |
|---|
Available from CRM.COM R11.0.0 |
|
payment_medium_type_identifier (optional) | Payment Medium Type Identifier | The payment medium type to be added on account payment preference object. The allowed payment medium type identifier fields are the following: | Include Page |
|---|
| payment_medium_type_identifier |
|---|
| payment_medium_type_identifier |
|---|
|
| Tip |
|---|
Available from CRM.COM R11.0.0 |
|
payment_medium_brand_identifier (optional) | Payment Medium Brand Identifier | The payment medium brand to be added on account payment preference object. The allowed payment medium brand identifier fields are the following: | Include Page |
|---|
| payment_medium_brand_identifier |
|---|
| payment_medium_brand_identifier |
|---|
|
| Tip |
|---|
Available from CRM.COM R11.0.0 |
|
use_for_recurring_payments (optional) | Boolean | Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled billes allocated to the related accounts receivable |
cards_set (mandatory on conditions) | Set of Payment Gateway Cards Objects | The cards that are related with the Accounts Receivable Payment Preference, in case the payment preference is related with a payment gateway such as Stripe. This information is applicable only if the payment preference is related with a payment gateway. In that case it is mandatory to specify at least one card, which also needs to be set as the default card sepa |
business_identifier_code (optional) | String | The business identifier code that identifies the bank, which should be a 11 digits alphanumeric characters | Tip |
|---|
Available from CRM.COM R13.1.0 |
|
unique_mandate_reference (optional) | SEPA Object | The Single Euro Payments Area (SEPA) information that is related with the Accounrs Receivable Payment Preference This parameter is only applicable if the Payment Preference is of type Direct Debit or Custom. Application on Custom Type Payment Preferences may be vary based on the Custom Type Payment Preference configurationNumber | The unique reference which identifies each direct debit mandate that was signed by a Debtor for any given Creditor | Tip |
|---|
Available from CRM.COM R13.1.0 |
|
mandate_signing_date (optional)
| Date | The date that the mandate was signed from the Debtor | Tip |
|---|
Available from CRM.COM R13.1.0 |
|
mandate_termination_date (optional) | Date | The date that the mandate will be terminated. No payments should be send after that date (inclusive) | Tip |
|---|
Available from CRM.COM R13.1.0 |
|