Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Expand
titleaccounts_receivable_payment_preference object parameter data


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


state

(optional)

Boolean

Indicates if the retrieved payment preference is active or not. The supported values are ACTIVE or INACTIVE. If not specified then it is considered as active

Tip

Available from CRM.COM R15.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 bills allocated to the related accounts receivable. Applicable only if the Payment Preference is related to a Payment Gateway

Tip

Depracated from CRM.COM R16.0.0 (and replaced by opt_in_for_subscriptions). The parameter will still function but it will not be maintained


 opt_in_for_subscriptions

(optional)

 Boolean

Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled

billes

bills allocated to the related accounts receivable, related to its subscriptions. Applicable only if the Payment Preference is related to a Payment Gateway or a Wallet

Tip

Available from CRM.COM R16.0.0


Tip

Wallet as a payment preference is available from CRM.COM R17.0.0


 opt_in_for_purchases

(optional)

 Boolean

Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable, related to purchases. Applicable only if the Payment Preference is related to a Payment Gateway or a Wallet

Tip

Available from CRM.COM R16.0.0


Tip

Wallet as a payment preference is available from CRM.COM R17.0.0


iban

(optional)

String

The international bank account number

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

Tip

Available from CRM.COM R13.1.0


business_identifier_code

(optional)

String

The business identifier code that identifies the bank

, which should be a 11 digits alphanumeric characters

(supports 8 or 11 alphanumeric characters)

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

Tip

Available from CRM.COM R13.1.0


unique_mandate_reference

(optional)

Number

The unique reference, which identifies

each direct debit

a mandate that was signed by a Debtor for any given Creditor (supports up to 35 alphanumeric characters)

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

Tip

Available from CRM.COM R13.1.0


mandate_signing_date

(optional)

Date

The date that the mandate was signed

from the Debtor

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

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)

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

Tip

Available from CRM.COM R13.1.0


gateway_payment_method_token

(optional)

String

The token of the payment gateway payment method that will be registered (defines payment methods other than cards)

Tip

Available from CRM.COM R14.2.0


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

 

Include Page
Web API - Updating Sets
Web API - Updating Sets

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

...