Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleaccounts_receivable_payment_preference object parameter data

Defines if a new or existing payment preference will be used. In the case of a payment preference then it also defines if the existing payment preference should be updated or not. The supported values are the following:

ADD, UPDATE, REMOVE

Name

Type

Description

action

(mandatory)

String

account_holder

(optional)

String

The account holder of the retrieved payment preference

is_default

(mandatory)

Boolean

Defines if the payment preference is default or not.

 

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