- Created by George Rossides (Unlicensed) , last modified on Jan 29, 2015
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Next »
Name | Type | Description | ||||||||||||
classification_identifier (mandatory on conditions) | Accounts receivable classification identifier | The accounts receivable classification identifier. This is applicable and mandatory if the action is set to NEW. The allowed classification identifier fields are the following:
This is applicable if the action is set to NEW | ||||||||||||
(optional) | Set of Presentment Preferences Object | The presentment preferences of the retrieved accounts receivable. This is applicable if the action is set to NEW | ||||||||||||
(optional) | Set of Payment Preferences Object | The payment preferences of the retrieved accounts receivable. This is applicable if the action is set to NEW |
Referred Parameter Objects Data
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| presentment_preference_identifier (mandatory) | Identifier | The identifier of the presentment preference to be added on account presentment preference object. The allowed presentment preference identifier fields are the following:
| ||||||||||||
state (optional) | String | Indicates 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 | ||||||||||||
(mandatory on conditions) | 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 Deprecated from CRM.COM R17.0.0 | ||||||||||||
(mandatory on conditions) | 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 Deprecated from CRM.COM R17.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| action (mandatory) | String | Defines if a new or existing email will be used. In the case of an existing email then it also defines if the existing email should be updated or not. The supported values are the following: NEW, EXISTING, EXISTINGUPDATED |
| type (mandatory on conditions) | String | The contact information email that should be used. This is applicable and mandatory only if the action is set to EXISTING or EXISTINGUPDATED. The supported options are the following: PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
(mandatory on conditions) | Email object | The email to be created (if action is set to NEW) or updated (if action is set to EXISTINGUPDATED). This is applicable and mandatory only if the action is set to NEW or EXISTINGUPDATED. |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
type (mandatory) | String | The type of the retrieved email which can be PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
is_primary (mandatory on conditions) | Boolean | Weather the email is the primary one Applicable from CRM.COM R16.1.0 onwards |
email_address (mandatory) | String | The address of the retrieved email |
notes (optional) | String | The notes of the retrieved email |
udf_string_1 (optional) | String | User Defined Field of type String |
udf_string_2 (optional) | String | User Defined Field of type String |
udf_string_3 (optional) | String | User Defined Field of type String |
udf_string_4 (optional) | String | User Defined Field of type String |
udf_string_5 (optional) | String | User Defined Field of type String |
udf_string_6 (optional) | String | User Defined Field of type String |
udf_string_7 (optional) | String | User Defined Field of type String |
udf_string_8 (optional) | String | User Defined Field of type String |
udf_float_1 (optional) | Float | User Defined Field of type Float |
udf_float_2 (optional) | Float | User Defined Field of type Float |
udf_float_3 (optional) | Float | User Defined Field of type Float |
udf_float_4 (optional) | Float | User Defined Field of type Float |
udf_date_1 (optional) | Date | User Defined Field of type Date |
udf_date_2 (optional) | Date | User Defined Field of type Date |
udf_date_3 (optional) | Date | User Defined Field of type Date |
udf_date_4 (optional) | Date | User Defined Field of type Date |
Name | Type | Description |
|---|---|---|
| action (mandatory) | String | Defines if a new or existing phone will be used. In the case of an existing phone then it also defines if the existing phone should be updated or not. The supported values are the following: NEW, EXISTING, EXISTINGUPDATED |
| type (mandatory on conditions) | String | The contact information phone that should be used. This is applicable and mandatory only if the action is set to EXISTING or EXISTINGUPDATED. The supported options are the following: LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
(mandatory on conditions) | Email object | The email to be created (if action is set to NEW) or updated (if action is set to EXISTINGUPDATED). This is applicable and mandatory only if the action is set to NEW or EXISTINGUPDATED. |
Referred Objects Response Data
Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type (mandatory) | String | The type of the phone which can be LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 | ||||||||||||||||||
is_primary (mandatory on conditions) | Boolean | Weather the phone is the primary one Applicable from CRM.COM R16.1.0 onwards | ||||||||||||||||||
number (mandatory) | String | The number of the phone | ||||||||||||||||||
area_code (optional) | String | The area code of the phone | ||||||||||||||||||
country_identifier (optional) | Country identifier | The country of the phone. The allowed country identifier fields are the following:
| ||||||||||||||||||
notes (optional) | String | The notes of the phone | ||||||||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date |
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:
| ||||||||||||
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:
| ||||||||||||
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:
| ||||||||||||
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:
| ||||||||||||
notes (optional) | String | The notes to be added on account payment preference object. Available from CRM.COM R10.1.0 | ||||||||||||
payment_medium_identifier (optional) | String | The payment medium identifier to be added on account payment preference object. 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 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:
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:
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 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 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 Available from CRM.COM R16.0.0 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 Available from CRM.COM R16.0.0 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 Available from CRM.COM R13.1.0 | ||||||||||||
business_identifier_code (optional) | String | The business identifier code that identifies the bank (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 Available from CRM.COM R13.1.0 | ||||||||||||
unique_mandate_reference (optional) | Number | The unique reference, which identifies 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 Available from CRM.COM R13.1.0 | ||||||||||||
mandate_signing_date (optional) | Date | The date that the mandate was signed 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 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 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) Available from CRM.COM R14.2.0 | ||||||||||||
(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
If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
|
Referred Objects Response Data
Name | Type | Description |
number (semi-optional) | String | The card's number, which should be a 16 digits number For releases prior CRM.COM R14.2.0, this parameter is mandatory |
last_digits (semi-optional) | Number | The card last 4 digits Available from CRM.COM R14.2.0 |
expiration_month (mandatory) | Number | The card's expiration month, which can be from 1 to 12 |
expiration_year (mandatory) | Number | The card's expiration year which should be a 4 digits number |
card_security_code (optional) | Number | The security code of the card, which should be a 3 digits number From CRM.COM R14.2.0, this parameter is optional |
card_holder_name (mandatory) | String | The card holders name, as provided during the registration of the card |
brand (mandatory on conditions) | String | The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateway are the following:
This attribute is mandatory for Payeezy Payment Gateway Available from CRM.COM R14.3.0 |
same_as_billing_address (optional) | Boolean | Sets the card's billing address same as the account's receivable billing address Available from CRM.COM R14.3.0 |
address_line_1 (optional) | String | Information related with the card's billing address |
address_line_2 (optional) | String | Information related with the card's billing address |
address_city (optional) | String | Information related with the card's billing address |
address_zip (optional) | String | Information related with the card's billing address |
address_state (optional) | String | Information related with the card's billing address |
address_country (optional) | String | Information related with the card's billing address |
card_token (optional) | String | The token of the card that will be registered Available from CRM.COM R14.2.0 |
consumer_token (optional) | String | The consumer token of the card that will be registered Available from CRM.COM R14.26.0 |
default (mandatory) | Boolean | It defines the default payment gateway card that should be used while automatically creating payments against that specific accounts receivable. The default card is also set on payments done using the specific payment preference, although the user can modify this information, by selecting an additional card. |
- No labels