Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleaccounts_receivable_payment_preference object parameter data
Available from CRM.COM R5.0.0

 

Available from CRM.COM R5.0.0

 

Name

Type

Description

account_holder

(optional)

String

The account holder of the retrieved payment preference

bank_account_number

(optional)

String

The bank account number of the retrieved payment preference

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

Tip

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

Tip

Anchor
accounts_receivable_payment_preference_parameters referred objects
accounts_receivable_payment_preference_parameters referred objects
Referred Objects Response Data

Include Page
payment_gateway_card_parameters
payment_gateway_card_parameters