Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleaccounts_receivable_presentment_preference object parameter data
Name
Type
Description
action

(mandatory)

String

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

ADD, UPDATE, REMOVE

accounts_receivable_presentment_preference_identifier

(mandatory and applicable only on update or remove)

Accounts Receivable Presentment Preference Identifier 

 The identifier of the accounts receivable presentment preference that will be updated. The allowed accounts receivable presentment preference identifier fields are the following:

Include Page
accounts_receivable_presentment_preference_identifier
accounts_receivable_presentment_preference_identifier

presentment_preference_identifier

(mandatory and applicable only on add)

Presentment Preference Identifier  

The identifier of the presentment preference to be added on account presentment preference objectrelated with the accounts receivable presentment preference that will be updated. The allowed presentment preference identifier fields are the following:

Include Page
presentment_preference_identifier
presentment_preference_identifier

state

(optional and applicable only on add or update)

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

email

(mandatory and applicable only on add or update)

Presentment Preference Email Object

The email that should be related with the presentment preference. The email is mandatory and applicable only if the specified presentment preference is of type Email

phone

(mandatory  and applicable only on add or update)

Presentment Preference Phone Object

The phone that should be related with the presentment preference. The phone is mandatory and applicable only if the specified presentment preference is of type SMS

Anchor
presentment preference update referred object parameters
presentment preference update referred object parameters
Referred Objects Response Data

Include Page
presentment_preference_email_parameter
presentment_preference_email_parameter

Include Page
presentment_preference_phone_parameter
presentment_preference_phone_parameter