Skip to end of banner
Go to start of banner

accounts_receivable_payment_preference_update_parameter

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

 accounts_receivable_payment_preference object parameter data

Name

Type

Description

action

(mandatory)

String

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

accounts_receivable_payment_preference_identifier

(mandatory and applicable only on update or remove)

Accounts Receivable Payment Preference Identifier  

The identifier of the accounts receivable payment preference to be updated. The allowed accounts receivable payment preference identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of accounts receivable payment preference

payment_preference_identifier

(semi-optional)

Identifier  

The identifier of the payment preference. The allowed payment preference identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of payment preference

name 

(semi-optional)

String

The name of payment preference

alternative_code 

(semi-optional)

String

The alternative code of payment preference

payment_medium_identifier

(semi-optional)

String

The payment medium identifier related with the accounts receivable payment preference

Available from CRM.COM R11.0.0

bank_account_number

(semi-optional)

StringThe bank account number related with the accounts receivable payment preference

Available from CRM.COM R11.0.0

 


payment_preference_identifier

(mandatory and applicable only on add)

Payment Preference Identifier  

The identifier of the payment preference to be updated on the related accounts receivable payment preference object. The allowed payment preference identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of payment preference

name 

(semi-optional)

String

The name of payment preference

alternative_code 

(semi-optional)

String

The alternative code of payment preference

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

bank_account_type_identifier

(optional)

Bank Account Type 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:

Name

Type

Description

id 

(semi-optional)

String

The ID of bank account type

name

(semi-optional)

String

The name of bank account type

alternative_code 

(semi-optional)

String

The alternative code of bank account type

bank_identifier

(optional)

Bank Identifier 

The identifier of the bank to be added on account payment preference object. The allowed bank identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of bank

name 

(semi-optional)

String

The name of bank

alternative_code 

(semi-optional)

String

The alternative code of bank

bank_branch_identifier

(optional)

Bank Branch Identifier 

The identifier of the bank branch to be added on account payment preference object. The allowed bank branch identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of bank branch

name

(semi-optional)

String

The name of bank branch

alternative_code 

(semi-optional)

String

The alternative code of bank branch

  • No labels