- Created by George Rossides, last modified by Former user on Mar 21, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 9 Next »
Name | Type | Description | ||||||||||||
type_identifier (mandatory) | Subscription type identifier | The subscription type of the subscription. The allowed subscription type identifier fields are the following:
| ||||||||||||
notes (optional) | String | Notes for the subscription to be created | ||||||||||||
owned_by_group_identifier (optional) | Group identifier | The group that will be owning the subscription. The allowed group identifier fields are the following:
| ||||||||||||
privacy_level_identifier (optional) | Privacy level identifier | The subscription's privacy level. The allowed privacy level identifier fields are the following:
| ||||||||||||
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 | ||||||||||||
(mandatory) | Accounts receivable object | The accounts receivable owning the subscription to be created | ||||||||||||
(mandatory) | Billing terms object | The billing terms of the subscription to be created | ||||||||||||
(mandatory on conditions) | Address object | The address of the subscription to be created. This information is mandatory if the address rule at the active subscription definition is set up as mandatory or the subscription type is not included in the exceptional types. Subscription address is mandatory up to CRM.COM R12 |
Referred Parameter Objects Data
Name | Type | Description | ||||||||||||
| action (mandatory) | String | Defines if a new or existing accounts receivable should be used. The supported values are the following: NEW, EXISTING | ||||||||||||
accounts_receivable_identifier (mandatory on conditions) | Accounts receivable identifier | An existing accounts receivable that should be used. This is applicable and mandatory if the action is set to EXISTING. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
name (mandatory on conditions) | String | The name of the accounts receivable. This is applicable and mandatory if the action is set to NEW | ||||||||||||
description (optional) | String | The description of the retrieved accounts receivable. This is applicable if the action is set to NEW | ||||||||||||
notes (optional) | String | The notes of the retrieved accounts receivable. This is applicable if the action is set to NEW | ||||||||||||
vat_number (optional) | String | The VAT number of the retrieved accounts receivable. This is applicable if the action is set to NEW | ||||||||||||
credit_limit (optional) | Number | Is the maximum amount of credit that can be provided to the specific accounts receivable, or in other words the maximum balance that the accounts receivable can ever reach. This is applicable if the action is set to NEW Deprecated from CRM.COM R11.0.0 | ||||||||||||
credit_period_operator (optional) | String | The credit period operator. The supported values are the following: PLUS,MINUS This is applicable if the action is set to NEW | ||||||||||||
credit_period (optional) | Number | Credit period is the length of time for which a customer is allowed to settle any given debit. This is applicable if the action is set to NEW | ||||||||||||
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 | ||||||||||||
credit_rating_code (mandatory on conditions) | String | The code of the credit rating. This is applicable and mandatory if the action is set to NEW. The supported codes are the following: AAA, AA, A, BAA, BA, B, CAA, CA, C This is applicable if the action is set to NEW | ||||||||||||
owned_by_group_identifier (optional) | Group identifier | The group owning the accounts receivable. This is applicable if the action is set to NEW. The allowed group identifier fields are the following:
Deprecated from CRM.COM R18.0.0 | ||||||||||||
owned_by_business_unit_identifier (optional) | Business Unit identifier | The business unit owning the accounts receivable. This is applicable if the action is set to NEW. The allowed business unit identifier fields are the following:
Available from CRM.COM R18.0.0 | ||||||||||||
privacy_level_identifier (optional) | Privacy level identifier | The privacy level of the accounts receivable. This is applicable if the action is set to NEW. The allowed privacy level identifier fields are the following:
Deprecated from CRM.COM R18.0.0 | ||||||||||||
currency_identifier (optional) | Currency identifier | The identifier of the currency to be used. This is optional information but it is only applicable when creating a new accunts receivable. The allowed currency identifier fields are the following:
Available from CRM.COM R10.0.0 | ||||||||||||
account_manager (optional) | User Identifier | The identifier of the user that should be set as the Account Manager. The allowed user identifier fields are the following
Assigning an Account Manager is only applicable for Accounts Receivables that are owned by a COMPANY Available from CRM.COM R14.0.0 | ||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String. This is applicable if the action is set to NEW | ||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String. This is applicable if the action is set to NEW | ||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String. This is applicable if the action is set to NEW | ||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String. This is applicable if the action is set to NEW | ||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String. This is applicable if the action is set to NEW | ||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String. This is applicable if the action is set to NEW | ||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String. This is applicable if the action is set to NEW | ||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String. This is applicable if the action is set to NEW | ||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float. This is applicable if the action is set to NEW | ||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float. This is applicable if the action is set to NEW | ||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float. This is applicable if the action is set to NEW | ||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float. This is applicable if the action is set to NEW | ||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date. This is applicable if the action is set to NEW | ||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date. This is applicable if the action is set to NEW | ||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date. This is applicable if the action is set to NEW | ||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date. This is applicable if the action is set to NEW | ||||||||||||
custom_field_set (optional) | Set of Custom Fields | The custom fields that are associated with the accounts receivable If no records are specified in the set then nothing will be updated. To add or update a value on a custom field use the custom field name as configured in CRM.COM along with the respective value. To remove a value from a custom field use the custom field name as configured in CRM.COM along with an empty value "custom_field_set": [
{"field_name" : "value"},
{"field_name" : "value"}
]
Available from CRM.COM R16.2.0 | ||||||||||||
(mandatory on conditions) | Contact information object | The contact information of the accounts receivable owner. This is applicable and mandatory if the action is set to NEW | ||||||||||||
(mandatory on conditions) | Billing address object | The accounts receivable billing address. This is applicable and mandatory if the action is set to NEW From CRM.COM R14.3.0, billing_address is mandatory based on the accounts receivable definitions' billing address rules | ||||||||||||
(optional) | Wallet Top Up Rules Object | The accounts receivable wallet top up rules. Applicable only if the account owner owns a wallet and has opt in to recurring payments through payment preferences Available from CRM.COM R14.2.0 | ||||||||||||
(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 | ||||||||||||
(mandatory on conditions) | Set of Access Token Objects | The access tokens that will be associated with the accounts receivable. This information is mandatory if the active access token definition is set up to require at least one access token for each accounts receivable Available from CRM.COM R8.0.0 |
Referred Parameter Objects Data
Name | Type | Description | |||||||||||||||||||||
| action (mandatory) | String | Defines if a new or existing contact information should be used. The supported values are the following: NEW, EXISTING | |||||||||||||||||||||
contact_information_identifier (mandatory on conditions) | Contact information identifier | An existing contact information that should be used. This is applicable and mandatory if the action is set to EXISTING. The allowed contact information identifier fields are the following:
| |||||||||||||||||||||
type (mandatory on conditions) | String | The type of the contact information which can be PERSON or COMPANY. Applicable and mandatory if the action is set to NEW | |||||||||||||||||||||
title (optional) | String | The title of the contact information. Applicable only if the type is PERSON and the action is set to NEW | |||||||||||||||||||||
first_name (mandatory on conditions) | String | The first name of the contact information. Applicable and mandatory only if the type is PERSON and the action is set to NEW | |||||||||||||||||||||
middle_name (optional) | String | The middle name of the contact information. Applicable only if the type is PERSON and the action is set to NEW | |||||||||||||||||||||
last_name (mandatory on conditions) | String | The last name of the contact information. Applicable and mandatory only if the type is PERSON and the action is set to NEW | |||||||||||||||||||||
company_name (mandatory on conditions) | Sting | The company name of the contact information. Applicable and mandatory only if the type is COMPANY and the action is set to NEW | |||||||||||||||||||||
category_identifier (optional) | Identifier | The identifier of the contact category that will be associate with the contact information. The allowed contact category identifier fields are the following:
Applicable only if the action is set to NEW | |||||||||||||||||||||
owned_by_group_identifier (optional) | Group identifier | The group owning the contact information. The allowed group identifier fields are the following:
Applicable only if the action is set to NEW Deprecated from CRM.COM R18.0.0 | |||||||||||||||||||||
owned_by_business_unit_identifier (optional) | Business Unit identifier | The business unit owning the contact information. The allowed business unit identifier fields are the following:
Applicable only if the action is set to NEW Available from CRM.COM R18.0.0 | |||||||||||||||||||||
privacy_level_identifier (optional) | Privacy level identifier | The privacy level of the contact information. The allowed privacy level identifier fields are the following:
Applicable only if the action is set to NEW Deprecated from CRM.COM R18.0.0 | |||||||||||||||||||||
send_direct_marketing_material (optional) | Boolean | The Contact Information's authorization setting for Direct Marketing Available from CRM.COM R9.0.0 | |||||||||||||||||||||
send_affiliate_marketing_material (optional) | Boolean | The Contact Information's authorization setting for Affiliate Marketing Available from CRM.COM R9.0.0 | |||||||||||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_9 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_10 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_11 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_12 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_13 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_14 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_15 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_string_16 (optional) | String | User Defined Field of type String. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_float_5 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_float_6 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_float_7 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_float_8 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_date_5 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_date_6 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_date_7 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to NEW | |||||||||||||||||||||
udf_date_8 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to NEW | |||||||||||||||||||||
custom_field_set (optional) | Set of Custom Fields | The custom fields that are associated with the contact information If no records are specified in the set then nothing will be updated. To add or update a value on a custom field use the custom field name as configured in CRM.COM along with the respective value. To remove a value from a custom field use the custom field name as configured in CRM.COM along with an empty value "custom_field_set": [
{"field_name" : "value"},
{"field_name" : "value"}
]
Available from CRM.COM R16.2.0 | |||||||||||||||||||||
(optional) | Demographics object | The demographics of the contact information. Applicable only if the type is PERSON and the action is set to NEW | |||||||||||||||||||||
(optional) | Company profile object | The company profile of the contact information. Applicable only if the type is COMPANY and the action is set to NEW | |||||||||||||||||||||
(optional) | Address object | The addresses of the contact information. Applicable only if the action is set to NEW | |||||||||||||||||||||
(optional) | Phone object | The phone of the contact information. Applicable only if the action is set to NEW | |||||||||||||||||||||
(optional) | Email object | The email of the contact information. Applicable only if the action is set to NEW |
Referred Parameter Objects Data
Name | Type | Description | ||||||||||||||||||
gender (optional) | String | The gender of the contact information which can be MALE or FEMALE | ||||||||||||||||||
id_number (optional) | String | The ID number of the contact information | ||||||||||||||||||
id_number_expiration_date (optional) | Date | The expiration date of the ID number Available from CRM.COM R14.0.0 | ||||||||||||||||||
passport_number (optional) | String | The passport number of the contact information | ||||||||||||||||||
passport_number_expiration_date (optional)
| Date | The expiration date of the passport Available from CRM.COM R14.0.0 | ||||||||||||||||||
social_security_number (optional) | String | The social security number of the contact information | ||||||||||||||||||
country_of_residence_identifier (optional) | Country identifier | The country of residence of the contact information. The allowed country identifier fields are the following:
| ||||||||||||||||||
id_issued_by_country_identifier (optional) | Country identifier | The ID issued country of the contact information. The allowed country identifier fields are the following:
| ||||||||||||||||||
passport_issued_by_country_identifier (optional) | Country identifier | The passport issued country of the contact information. The allowed country identifier fields are the following:
| ||||||||||||||||||
industry_identifier (optional) | Industry identifier | The industry of the contact information. The allowed industry identifier fields are the following:
| ||||||||||||||||||
industry_sector_identifier (optional) | Industry Sector identifier | The sector of the contact information. The allowed industry sector identifier fields are the following:
| ||||||||||||||||||
(optional) | Date of Birth Object | The date of birth of the contact information | ||||||||||||||||||
(optional) | Name Day Object | The name day of the contact information |
Referred Parameter Objects Data
Name | Type | Description |
|---|---|---|
day (optional) | Integer | The day of the retrieved date of birth |
month (optional) | Integer | The month of the retrieved date of birth |
year (optional) | Integer | The year of the retrieved date of birth |
Name | Type | Description |
|---|---|---|
day (optional) | Integer | The day of the retrieved name day |
month (optional) | Integer | The month of the retrieved name day |
Name | Type | Description | ||||||||||||||||||
profile_year (optional) | Number | The profile year of the contact information | ||||||||||||||||||
annual_turnover (optional) | Number | The annual turnover of the contact information | ||||||||||||||||||
established_date (optional) | Date | The established date of the contact information | ||||||||||||||||||
number_of_employees (optional) | Number | The number of employees of the contact information | ||||||||||||||||||
registration_number (optional) | String | The registration number of the contact information | ||||||||||||||||||
vat_registration_number (optional) | String | The vat registration number of the contact information | ||||||||||||||||||
vat_registered_by (optional) | String | The vat registration by of the contact information | ||||||||||||||||||
vat_registration_date (optional) | Date | The vat registration date of the contact information | ||||||||||||||||||
tax_reference_number (optional) | String | The tax reference number of the contact information | ||||||||||||||||||
registered_in_country_identifier | Country Identifier | The country of registration of the contact information. The allowed country identifier fields are the following:
| ||||||||||||||||||
industry_identifier (optional) | Industry identifier | The industry of the contact information. The allowed industry identifier fields are the following:
| ||||||||||||||||||
industry_sector_identifier (optional) | Industry Sector identifier | The sector of the contact information. The allowed industry sector identifier fields are the following:
|
From R14.2.0, the following object is applicable for CRM.COM Address Format
| Name | Type | Description | ||||||||||||||||||
type (mandatory) | String | The type of the address which can be added HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 | ||||||||||||||||||
is_primary (mandatory on conditions) | Boolean | Weather the address is the primary one Applicable from CRM.COM R16.1.0 onwards | ||||||||||||||||||
postal_code (optional) | String | The postal code of the address | ||||||||||||||||||
street_name (mandatory on conditions) | String | The street name of the address | ||||||||||||||||||
street_number (optional) | String | The street number of the address | ||||||||||||||||||
floor (optional) | Integer | The floor of the address | ||||||||||||||||||
apartment_number (optional) | String | The apartment number of the address | ||||||||||||||||||
area (optional) | String | The area of the address | ||||||||||||||||||
town_city (optional) | String | The town/city of the address | ||||||||||||||||||
district (optional) | String | The district of the address | ||||||||||||||||||
municipality (optional)
| String | The municipality of the address | ||||||||||||||||||
country_identifier (optional) | Country identifier | The country of the address. The allowed country identifier fields are the following:
| ||||||||||||||||||
po_box (optional) | String | The PO box of the address | ||||||||||||||||||
po_box_postal_code (optional) | String | The PO box postal code of the address | ||||||||||||||||||
care_of (optional) | String | The care of person of the address | ||||||||||||||||||
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_string_9 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_10 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_11 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_12 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_13 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_14 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_15 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_16 (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 | ||||||||||||||||||
type (mandatory) | String | The type of the address which can be added HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 | ||||||||||||||||||
postal_code (optional) | String | The postal code of the address | ||||||||||||||||||
town_city (optional) | String | The town/city of the address | ||||||||||||||||||
country_identifier (optional) | Country identifier | The country of the address. The allowed country identifier fields are the following:
| ||||||||||||||||||
address_line_1 (mandatory) | String | The address line 1 | ||||||||||||||||||
address_line_2 (optional) | String | The address line 2 | ||||||||||||||||||
state_province_county (optional) | String | The state or province or county of the address. | ||||||||||||||||||
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_string_9 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_10 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_11 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_12 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_13 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_14 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_15 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_16 (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 | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 |
|---|---|---|
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 address will be used. In the case of an existing address then it also defines if the existing address should be updated or not. The supported values are the following: NEW, EXISTING, EXISTINGUPDATED |
| type (mandatory on conditions) | String | The contact information address that should be set as the billing address address. This is applicable and mandatory only if the action is set to EXISTING or EXISTINGUPDATED. The supported options are the following: HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
(mandatory on conditions) | Address object | The address 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
From R14.2.0, the following object is applicable for CRM.COM Address Format
| Name | Type | Description | ||||||||||||||||||
type (mandatory) | String | The type of the address which can be added HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 | ||||||||||||||||||
is_primary (mandatory on conditions) | Boolean | Weather the address is the primary one Applicable from CRM.COM R16.1.0 onwards | ||||||||||||||||||
postal_code (optional) | String | The postal code of the address | ||||||||||||||||||
street_name (mandatory on conditions) | String | The street name of the address | ||||||||||||||||||
street_number (optional) | String | The street number of the address | ||||||||||||||||||
floor (optional) | Integer | The floor of the address | ||||||||||||||||||
apartment_number (optional) | String | The apartment number of the address | ||||||||||||||||||
area (optional) | String | The area of the address | ||||||||||||||||||
town_city (optional) | String | The town/city of the address | ||||||||||||||||||
district (optional) | String | The district of the address | ||||||||||||||||||
municipality (optional)
| String | The municipality of the address | ||||||||||||||||||
country_identifier (optional) | Country identifier | The country of the address. The allowed country identifier fields are the following:
| ||||||||||||||||||
po_box (optional) | String | The PO box of the address | ||||||||||||||||||
po_box_postal_code (optional) | String | The PO box postal code of the address | ||||||||||||||||||
care_of (optional) | String | The care of person of the address | ||||||||||||||||||
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_string_9 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_10 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_11 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_12 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_13 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_14 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_15 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_16 (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 | ||||||||||||||||||
type (mandatory) | String | The type of the address which can be added HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 | ||||||||||||||||||
postal_code (optional) | String | The postal code of the address | ||||||||||||||||||
town_city (optional) | String | The town/city of the address | ||||||||||||||||||
country_identifier (optional) | Country identifier | The country of the address. The allowed country identifier fields are the following:
| ||||||||||||||||||
address_line_1 (mandatory) | String | The address line 1 | ||||||||||||||||||
address_line_2 (optional) | String | The address line 2 | ||||||||||||||||||
state_province_county (optional) | String | The state or province or county of the address. | ||||||||||||||||||
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_string_9 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_10 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_11 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_12 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_13 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_14 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_15 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_16 (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 |
|---|---|---|
wallet_balance_threshold (mandatory) | Number | The wallet balance threshold that will trigger the automatic wallet top-up |
top_up_amount (mandatory) | Number | The amount that will top up the wallet balance |
frequency (mandatory) | Number | The minimum period (in days) between wallet top ups |
(optional) | Set of Allotment Product Conditions | A set of products that will be allowed to consume the specified top up amount If no records are specified in the set then nothing will be updated. 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": "remove",
...........
},
{
"action": "add",
...........
}
]
|
Referred Objects Response Data
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
product_identifier | Product identifier | The product related with the wallet transaction allotment. The allowed product identifier fields are the following:
|
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. |
Name | Type | Description | ||||||||||||
| action (mandatory) | String | Defines if a new or existing access token should be used. The supported values are the following: ADD_NEW, ADD_EXISTING The NEW option can be used only if access tokens are allowed to be created on creating reward participants, as specified in access token definitions | ||||||||||||
access_token_identifier (mandatory on conditions) | Access Token identifier | An existing access token that should be used. This is applicable and mandatory if the action is set to EXISTING. Only effective access tokens can be used. The allowed access token identifier fields are the following:
| ||||||||||||
authentication_code (mandatory on conditions) | String | The authentication code of the access token that will be created. This information is not mandatory if set to be generated automatically, in the definition or the classification. Applicable only if the action is set to ADD_NEW | ||||||||||||
identifier (mandatory on conditions) | String | The identifier of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code. Applicable only if the action is set to ADD_NEW | ||||||||||||
pass_code (mandatory on conditions) | String | The pass code of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified. Applicable only if the action is set to ADD_NEW | ||||||||||||
classification_identifier (optional) | Access Token Classification Identifier | The identifier of the access token classification that will be related with the access token. The allowed access token classification identifier fields are the following:
Available from CRM.COM R10.0.0 | ||||||||||||
card_masked_number (optional) | String | The masked number of the credit card that will be related to the access token
Available from CRM.COM R16.2.0 | ||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 | ||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to ADD_NEW Available from CRM.COM R10.1.0 |
Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
billing_term_scheme_identifier (mandatory on conditions) | Billing term scheme identifier | The billing term scheme that will be used on the billing terms. The allowed billing term scheme identifier fields are the following:
The billing_term_scheme_identifier is considered as mandatory up until CRM.COM R13.0.0. From CRM.COM R14.0.0 the identifier becomes mandatory on conditions, which means that it is mandatory only as long as the subscription's type is not of classification Package. Subscription Types of classification Package provide a default Billing Term scheme and the billing_term_scheme_identifier is not applicable in such cases. | |||||||||
price_plan_identifier (mandatory on conditions) | Price plan identifier | The price plan that will be used on the billing terms. The allowed price plan identifier fields are the following:
The price_plan_identifier is considered as mandatory up until CRM.COM R11.2.0. From CRM.COM R11.2.0 the identifier becomes mandatory on conditions, which means that it is mandatory only as long as no default price plan is specified in the Billing Term Scheme From CRM.COM R14.0.0 if the subscription's type is of classification Package which provides a default Price Plan, then that price plan is automatically applied and the price_plan_identifier is not applicable. Deprecated from CRM.COM R15.0.0 | |||||||||
is_auto_renewed (optional) | Boolean | Defines whether the subscription's billing terms will be auto-renewed or not. If not specified, then the subscription's billing terms are marked as auto-renewed. Available from CRM.COM R15.0.0 | |||||||||
billing_cycle_day (mandatory on conditions) | Number | The billing cycle day of the billing terms that will be created. Billing cycle day is used to specify up to which day of the month a subscription should be billed. Applicable and mandatory only when Billing Term Scheme specifies an Anniversary Billing. Mandatory if no automations on how the billing cycle day should be set are defined in the Billing Term Scheme. Either a specific billing cycle day or the fact that the billing cycle day is the last day of each month are mandatory in this case. From CRM.COM R12.0.0, billing_cycle_day becomes mandatory on conditions. In previous releases this is optional. | |||||||||
billing_cycle_last_day_of_month (mandatory on conditions)
| Boolean | Defines whether Anniversary Subscriptions will be billed up until the last day of each month. Applicable only for Anniversary subscriptions and only if no automations on how the billing cycle day is set are defined on the Billing Term Scheme. Either a specific billing cycle day or the fact that the billing cycle day is the last day of each month are mandatory in this case. Available from CRM.COM R12.0.0 | |||||||||
agreement_date (mandatory) | Date | The agreement date of the billing terms that will be created. Billing terms agreement date is used to log the date that the billing terms were agreed and signed by the customer. | |||||||||
billing_frequency (mandatory on conditions) | String | The billing frequency of the billing terms that will be created. Billing Frequencies are used to denote how often a subscription should be billed.The supported options are the following: DAILY, WEEKLY, MONTHLY, QUARTERLY, BIANNUAL, ANNUAL, TWOYEARS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 Billing frequency is applicable and mandatory only if the specified billing term scheme is of type "Normal" From CRM.COM R14.0.0 the billing frequency is not mandatory if the subscription's type is of classification Package that provides a default Billing Frequency (it can be amended though). | |||||||||
(optional) | Binding information object | The binding information of the billing term that will be created. Binding information is used to determine if a customer is contractually committed to receive services from the service provider for a fixed period of time. | |||||||||
concurrent_usage_based_pricing (mandatory on conditions) | Concurrent usage based pricing object | Concurrent usage based pricing is used to apply pricing and billing rules based on the subscription's concurrent usage which is agreed between the customer and the company providing those service. Concurrent usage based pricing is applicable and mandatory only if it is supported by the billing term schemes | |||||||||
period_billed_in_advance (mandatory on conditions) | float | The period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated billing term scheme. If nothing is specified then the default value will be provided Icon Available from CRM.COM R15.0.0 | |||||||||
period_billed_in_advance_uot (mandatory on conditions) | String | The unit of time for the period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated billing term scheme. The supported values are DAYS, WEEKS or MONTHS. If nothing is specified then the default value will be provided Icon Available from CRM.COM R15.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
binding_period (mandatory) | String | The binding period which can be one of the following: WEEK, MONTH, QUARTER, BIANNUAL, ANNUAL, TWOYEARS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 From CRM.COM R14.0.0 the binding period becomes mandatory on conditions, which means that it is mandatory only as long as the subscription's type is not of classification Package which provides a default Binding period (it can be amended though). From CRM.COM R18.0.0 the binding period is mandatory (Package subscription types are deprecated) |
start_date (mandatory on conditions) | Date | The date that the binding period starts. From CRM.COM R14.0.0 onwards start_date is mandatory only if no configuration exists in Subscription Billing Term Definitions related to Binding Start Date Automation. From CRM.COM R18.0.0 the binding period is mandatory (Package subscription types are deprecated) |
Name | Type | Description |
|---|---|---|
concurrent_usage (mandatory) | Number | Defines the concurrent usage of services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0 |
rate_percentage (mandatory) | Number | Defines the rate percentage that should be applied on all services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0 |
number_of_installed_items (mandatory on conditions) | Number | The agreed number of installed items that will be concurrently consuming the related subscription's services. Applicable and mandatory if concurrent usage billing method is set to "based on number of installed items". Available from CRM.COM R15.0.0 |
concurrent_usage_billing_method (mandatory) | String | Defines how the subscription will be billed for the agreed concurrent usage. Available options are:
If not specified, then the billing method is considered as "based on number of installed items". Available from CRM.COM R15.0.0 |
Name | Type | Description |
|---|---|---|
| action (mandatory) | String | Defines if a new or existing address will be used. In the case of an existing address then it also defines if the existing address should be updated or not. The supported values are the following: NEW, EXISTING, EXISTINGUPDATED |
| type (mandatory on conditions) | String | The contact information address that should be set as the subscription address. This is applicable and mandatory only if the action is set to EXISTING or EXISTINGUPDATED. The supported options are the following: SAMEASBILLINGADDRESS, HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
(mandatory on conditions) | Address object | The address 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
From R14.2.0, the following object is applicable for CRM.COM Address Format
| Name | Type | Description | ||||||||||||||||||
type (mandatory) | String | The type of the address which can be added HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 | ||||||||||||||||||
is_primary (mandatory on conditions) | Boolean | Weather the address is the primary one Applicable from CRM.COM R16.1.0 onwards | ||||||||||||||||||
postal_code (optional) | String | The postal code of the address | ||||||||||||||||||
street_name (mandatory on conditions) | String | The street name of the address | ||||||||||||||||||
street_number (optional) | String | The street number of the address | ||||||||||||||||||
floor (optional) | Integer | The floor of the address | ||||||||||||||||||
apartment_number (optional) | String | The apartment number of the address | ||||||||||||||||||
area (optional) | String | The area of the address | ||||||||||||||||||
town_city (optional) | String | The town/city of the address | ||||||||||||||||||
district (optional) | String | The district of the address | ||||||||||||||||||
municipality (optional)
| String | The municipality of the address | ||||||||||||||||||
country_identifier (optional) | Country identifier | The country of the address. The allowed country identifier fields are the following:
| ||||||||||||||||||
po_box (optional) | String | The PO box of the address | ||||||||||||||||||
po_box_postal_code (optional) | String | The PO box postal code of the address | ||||||||||||||||||
care_of (optional) | String | The care of person of the address | ||||||||||||||||||
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_string_9 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_10 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_11 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_12 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_13 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_14 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_15 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_16 (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 | ||||||||||||||||||
type (mandatory) | String | The type of the address which can be added HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 | ||||||||||||||||||
postal_code (optional) | String | The postal code of the address | ||||||||||||||||||
town_city (optional) | String | The town/city of the address | ||||||||||||||||||
country_identifier (optional) | Country identifier | The country of the address. The allowed country identifier fields are the following:
| ||||||||||||||||||
address_line_1 (mandatory) | String | The address line 1 | ||||||||||||||||||
address_line_2 (optional) | String | The address line 2 | ||||||||||||||||||
state_province_county (optional) | String | The state or province or county of the address. | ||||||||||||||||||
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_string_9 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_10 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_11 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_12 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_13 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_14 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_15 (optional) | String | User Defined Field of type String | ||||||||||||||||||
udf_string_16 (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 |
- No labels