Versions Compared

Key

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

Anchortoptop

...

width80%

Overview

CRMQL stands for CRM.COM Query Language and was developed by CRM.COM for querying information within the system. CRMQL supports specific types of queries which depend on the entity selected in each segment.

CRMQL Syntax

The structure of CRMQL syntax is described below (using regular expressions). In general, a CRMQL query consists of at least one set of criteria, one operator and one value. More than one set can be defined, separated by using AND or OR.

The values of criteria depend on the type of criteria and operator.

Global functions can be used instead of the set of criteria, operators and values.

Panel
id2
titleCRMQL Syntax
(criteria_name operator criteria_value|global_function) ((AND|OR) (criteria_name operator criteria_value|global_function))* 

CRMQL Functions

...

 

Date Functions

...

Returns the start of the day having the time set to 00:00:00.

...

new_date(year,month,day,hour,minutes,seconds)

...

Returns a Date based on the parameters passed to the function.

Any null values are replaced with the current date or time value

 

CRMQL Operators & Possible Values

Global Operators

Global operators are used to check whether a specific value is present within a set of values.

...

titleUsing Global Operator with Set Data Object

Global operators must be used when a Set of Data Objects is used:

Code Block
languagesql
titleGlobal operators - Set of Data Object
(criteria_name operator criteria_value|global_function) 
((AND EXIST|OR EXIST| AND NOT EXIST| OR NOT EXIST) (criteria_name operator criteria_value|global_function))* 

 

String Operators

...

 

Numeric Operators

OperatorPossible Values
=value | numeric field | empty
!=value | numeric field | empty
<>value | numeric field | empty
value | numeric field
>=value | numeric field
<value | numeric field
<=value | numeric field
between X and Yvalue | numeric field

 

Date Operators

...

value (dd/mm/yyyy) | date field | date function

...

 

Boolean Operators

...

Specific fields of objects (type, status, life cycle state) provide users the ability to select values from a pre-populated list. The list is populated after the operator is provided next to an <object.field> expression.

Type

...

Object

...

Field

...

Entity to be Populated

...

Status

...

Object

...

Field

...

Entity to be Populated

...

Object
Field
Entity to be Populated
contact_informationlife_cycle_stateLife cycle state name
subscriptionlife_cycle_stateLife cycle state name
accounts_receivablelife_cycle_stateLife cycle state name
billlife_cycle_stateLife cycle state name
activitylife_cycle_stateLife cycle state name
joblife_cycle_stateLife cycle state name
rewards_participantlife_cycle_stateLife cycle state name
service_requestlife_cycle_stateLife cycle state name
payment_gateway_requestlife_cycle_stateLife cycle state name
buy_in_advance_requestlife_cycle_stateLife cycle state name

CRMQL Main Data Objects

contact_information

...

category

(name)

...

Date

The birthday date of the contact information as defined by the combination or the day of birth, month of birth and year of birth, for example if the birthday is set on 24/04/1985 then if this tag is used within 2018 then this tag should retrieve 24/04/1985

...

Date

The birthday date within the current year, for example if the birthday is set 24/04/1985 then if this tag is used within 2018 then this tag should retrieve 24/04/2018

...

Date

The name day date within the current year, for example if the name day is 24/04 then if this tag is used within 2018 then this tag should retrieve 24/04/2018

...

industry

(name)

...

industry_sector

...

Anchor
top
top


 

 

Section


Column
width80%

Overview

CRMQL stands for CRM.COM Query Language and was developed by CRM.COM for querying information within the system. CRMQL supports specific types of queries which depend on the entity selected in each segment.

CRMQL Syntax

The structure of CRMQL syntax is described below (using regular expressions). In general, a CRMQL query consists of at least one set of criteria, one operator and one value. More than one set can be defined, separated by using AND or OR.

The values of criteria depend on the type of criteria and operator.

Global functions can be used instead of the set of criteria, operators and values.

Panel
id2
titleCRMQL Syntax
(criteria_name operator criteria_value|global_function) ((AND|OR) (criteria_name operator criteria_value|global_function))* 

CRMQL Functions

Anchor
global
global
Global Functions

FunctionParametersResultDescription
only_one(query)CRMQL queryBooleanReturns true if the specified query retrieves only one record; otherwise returns false.
more_than_one(query)CRMQL queryBooleanReturns true if the specified query retrieves more than one record; otherwise returns false.

 

Date Functions

FunctionParametersResultDescription
week_start()noneDateReturns the start of the week.
month_start()noneDateReturns the start of the month.
year_start()noneDateReturns the start of the year.
day_start()noneDate

Returns the start of the day having the time set to 00:00:00.

day_end()noneDateReturns the end of the day having the time set to 23:59:59.
current_date()noneDateReturns the current date and time.
week_end()noneDateReturns the end of the week.
month_end()noneDateReturns the end of the month.
year_end()noneDateReturns the end of the year.
seconds_before(date,seconds)Date, NumberDateReturns the date which is before the specified number of seconds.
minutes_before(date,minutes)Date, NumberDateReturns the date which is before the specified number of minutes.
hours_before(date,hours)Date, NumberDateReturns the date which is before the specified number of hours.
days_before(date,days)Date, NumberDateReturns the date which is before the specified number of days.
weeks_before(date,weeks)Date, NumberDateReturns the date which is before the specified number of weeks.
months_before(date,months)Date, NumberDateReturns the date which is before the specified number of months.
years_before(date,years)Date, NumberDateReturns the date which is before the specified number of years.
seconds_after(date,seconds)Date, NumberDateReturns the date which is after the specified number of seconds.
minutes_after(date,minutes)Date, NumberDateReturns the date which is after the specified number of minutes.
hours_after(date,hours)Date, NumberDateReturns the date which is after the specified number of hours.
days_after(date,days)Date, NumberDateReturns the date which is after the specified number of days.
weeks_after(date,weeks)Date, NumberDateReturns the date which is after the specified number of weeks.
months_after(date,months)Date, NumberDateReturns the date which is after the specified number of months.
years_after(date,years)Date, NumberDateReturns the date which is after the specified number of years.
date_only(date)DateDate Only (time set to 00:00:00)Returns the specified date having the time set to 00:00:00.
current_day()noneIntegerReturns the current day's value (1-31).
current_month()noneIntegerReturns the current month's value (1-12).
current_year()noneIntegerReturns the current year's value ().

new_date(year,month,day,hour,minutes,seconds)

Number, Number, Number, Number, Number, NumberDate

Returns a date based on the parameters passed to the function.

Any null values are replaced with the current date or time value

 

CRMQL Operators & Possible Values

Global Operators

Global operators are used to check whether a specific value is present within a set of values.

FunctionParametersResultDescription
exist(query)CRMQL queryBooleanReturns true if the specified query retrieves one or more records; otherwise returns false.
not exist(query)CRMQL queryBooleanReturns true if the specified query retrieves zero records, otherwise returns false.


Info
titleUsing Global Operator with Set Data Object

Global operators must be used when a Set of Data Objects is used:

Code Block
languagesql
titleGlobal operators - Set of Data Object
(criteria_name operator criteria_value|global_function) 
((AND EXIST|OR EXIST| AND NOT EXIST| OR NOT EXIST) (criteria_name operator criteria_value|global_function))* 


 

String Operators

OperatorPossible Values
=value | string field | empty
!=value | string field | empty
<>value | string field | empty
value | string field
>=value | string field
<value | string field
<=value | string field
likevalue
not likevalue
in()(value | string field) ( , (value | string field) )*
not in()(value | string field) ( , (value | string field) )*

 

Numeric Operators

OperatorPossible Values
=value | numeric field | empty
!=value | numeric field | empty
<>value | numeric field | empty
value | numeric field
>=value | numeric field
<value | numeric field
<=value | numeric field
between X and Yvalue | numeric field

 

Date Operators

OperatorPossible Values
=value (dd/mm/yyyy) | date field | date function | empty
!=value (dd/mm/yyyy) | date field | date function | empty
<>value (dd/mm/yyyy) | date field | date function | empty
value (dd/mm/yyyy) | date field | date function
>=value (dd/mm/yyyy) | date field | date function
<value (dd/mm/yyyy) | date field | date function
<=

value (dd/mm/yyyy) | date field | date function

between X and Yvalue (dd/mm/yyyy) | date field | date function

 

Boolean Operators

OperatorPossible Values
=true | false
!=true | false
<>true | false


CRMQL Autocomplete Enable Fields 

Specific fields of objects (type, status, life cycle state) provide users the ability to select values from a pre-populated list. The list is populated after the operator is provided next to an <object.field> expression.

Type


Object
Field
Entity to be Populated
contact_informationtypeType name
subscriptiontypeType name
activitytypeType name
jobtypeType name
service_requesttypeType name
payment_gateway_cardtypeType name
paymenttypeType name


Status

Object
Field
Entity to be Populated
billstatusStatus name
activitystatusStatus name
jobstatusStatus name
service_requeststatusStatus name


Life Cycle State
 

Object
Field
Entity to be Populated
contact_informationlife_cycle_stateLife cycle state name
subscriptionlife_cycle_stateLife cycle state name
accounts_receivablelife_cycle_stateLife cycle state name
billlife_cycle_stateLife cycle state name
activitylife_cycle_stateLife cycle state name
joblife_cycle_stateLife cycle state name
rewards_participantlife_cycle_stateLife cycle state name
service_requestlife_cycle_stateLife cycle state name
payment_gateway_requestlife_cycle_stateLife cycle state name
buy_in_advance_requestlife_cycle_stateLife cycle state name


CRMQL Main Data Objects

contact_information



FieldType
typeString
life_cycle_stateString
titleString
nameString
first_nameString
middle_nameString
last_nameString

category

(name)

String
genderString
day_of_birthNumber
month_of_birthNumber
year_of_birthNumber
birthday_date

Date

The birthday date of the contact information as defined by the combination of the day of birth, month of birth and year of birth, for example if the birthday is set on 24/04/1985 then if this tag is used within 2018, it should retrieve 24/04/1985

birthday_current_year_date

Date

The birthday date within the current year, for example if the birthday is set 24/04/1985 then if this tag is used within 2018, it should retrieve 24/04/2018

name_day_date

Date

The name day date within the current year, for example, if the name day is 24/04 then if this tag is used within 2018, it should retrieve 24/04/2018

name_day_dayNumber
name_day_monthNumber

industry

(name)

String

industry_sector

(name)

String
udf_string_1 - udf_string_16String
udf_float_1 - udf_float_8Float
udf_date_1 - udf_date_8Date
address

Set Data Object

phoneSet Data Object
emailSet Data Object
accounts_receivableSet Data Object
activitySet Data Object

consent_state

String

The state of the Contact's Consent. Applicable values are:

  • PENDING
  • ACCEPTED
  • REJECTED
  • WITHDRAWN

consent_updated_date

Date

created_date

Date

updated_date

Date

owned_by_group

Set Data Object

send_direct_ marketing_material

Boolean

send_affiliate_ marketing_material

Boolean

kyc_profile

String

The KYC profile name

kyc_profile_expiration_date

Date

kyc_profile_state

String

The KYC profile's life cycle state. Available values are: PENDING_VERIFICATION, VERIFIED, REFUTE, EXPIRED

 


 

Expand
titlecontact_information reference data objects

address

Field

Type

type

String

postal_code

String

street_name

String

area

String

town

String

district

String

municipality

String

country

String

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

phone

Field

Type

type

String

area_code

String

full_number

String

udf_string_1 - udf_string_
16
4String
udf_float_1 - udf_float_
8
4Float
udf_date_1 - udf_date_
8
4Date
address

Set Data Object

phoneSet Data Object

email

Set Data Object
accounts_receivableSet Data Object
activitySet Data Object

consent_state

String

The state of the Contact's Consent. Applicable values are:

  • PENDING
  • ACCEPTED
  • REJECTED
  • WITHDRAWN

consent_updated_date

Date

created_date

Date

updated_date

Date

owned_by_group

Set Data Object

send_direct_ marketing_material

Boolean

send_affiliate_ marketing_material

Boolean

kyc_profile

String

The KYC profile name

kyc_profile_expiration_date

Date

kyc_profile_state

String

The KYC profile's life cycle state. Available values are: PENDING_VERIFICATION, VERIFIED, REFUTE, EXPIRED

Expand
titlecontact_information reference data objects

address

String

Field

Type

type

String

postal_code

String

street_name

String

area

String

town

String

district

String

municipality

String

country

Field

Type

type

String

email

String

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date
phone

activity

Field

Type

numberString

type

(name)

String

area_code

String

full_number

String

status

(name)

String

category

(name)

String
life_cycle_stateString
start_dateDate
estimated_completion_dateDate
actual_completion_dateDate
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date
email

owned_by_group

Date
FieldType
typenumberString

email

String

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4nameString
alternative_codeString


 

subscription



FieldType

type

(name)

String

type_classification

String

life_cycle_stateString
numberString
is_free

Boolean

accounts_receivableSingle Data Object
billing_termsSingle Data Object
subscription_locationSingle Data Object
billing_addressSingle Data Object
serviceSet Data Object
installed_itemSet Data Object
owned_by_groupSet Data Object

closest_service_rated_up_to_date

Date

date_createdDate
applied_processSet Data Object
udf_string_1 - udf_string_8String
udf_float_1 - udf_float_8Float
udf_date_1 - udf_date_8Date

 


 

Expand
titlesubscription reference data objects

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_84String
udf_float_1 - udf_float_84Float
udf_date_1 - udf_date_84Date


billing_terms

Field

Type

unified_number

 String

scheme_name

 String

price_plan_name

 String

billing_method

 String

frequency

 String

cycle_day

 Number

binding_period

 String

binding_start_date

 Date

binding_end_date

 Date

agreement_date

 Date

effective_date

 Date

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

subscription_location

Field

Type

type

String

postal_code

String

street_name

String

area

String

town

String

district

String

municipality

String

country

String

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

billing_address

Field

Type

type

String

postal_code

String

street_name

String

area

String

town

String

district

String

municipality

String

country

String

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

owned_by_group

FieldType
numberString
nameString
alternative_codeString

service

rated_up_to_date

Field

Type

product

(code)

Single Data Object

life_cycle_state

String

life_cycle_state_start_date

Date

date_added

Date

date_removed

Date

rated_up_to_dateDate
is_free

Boolean

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4DateDate


Expand
titleservice reference data objects

product

Field

Type

type

 String



installed_item

Field

Type

serial_number

String

product

(code)

Single Data Object

date_added

Date

date_removed

Date

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


Expand
titleinstalled_item reference data objects

product

Field

Type

type

 String


applied_process

Field

Type

name

String

applied_date

Date 


 

accounts_receivable


 

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber
contact_informationSingle Data Object
subscriptionSet Data Object
billSet Data Object

classification

(name)

String
credit_limit_statusString
primary_accountBoolean
created_dateDate
updated_dateDate
billing_addressSingle Data Object
payment_preferenceSet Data Object
wallet

Single Data Object

Note: Only refers to 'Effective' wallets

parent_account

Single Data Object


presentment_preference

Set Data Object


assets


Set Data Object


owned_by_group

Set Data Object

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_8String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

 


 

Expand
titleaccounts_receivable reference data objects

contact_information

FieldType
typeString
life_cycle_stateString
nameString
first_nameString
middle_nameString
last_nameString

category

(name)

String
genderString
day_of_birthNumber
month_of_birthNumber
year_of_birthNumber
birthdayname_day_datedayDateNumber
birthday_current_yearname_day_monthNumber
name_day_date

Date

name_day_dayNumber
name_day_monthNumber

The name day date within the current year, for example, if the name day is 24/04 then if this tag is used within 2018, it should retrieve 24/04/2018

industry

(name)

String

industry_sector

(name)

String
address

Set Data Object

phoneSet Data Object
emailSet Data Object
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


Expand
titlecontact_information reference data objects

address

Field

Type

type

String

postal_code

String

street_name

String

area

String

town

String

district

String

municipality

String

country

String

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

phone

Field

Type

type

String

area_code

String

full_number

String

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

email

Field

Type

type

String

email

String

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


subscription

FieldType

type

(name)

String
life_cycle_stateString
numberString
billing_termsSingle Data Object
subscription_locationSingle Data Object
serviceDynamic Data Object
installed_itemDynamic Data Object
applied_processSet Data Object
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


Expand
titlesubscription reference data objects

billing_terms

Field

Type

unified_number

 String

scheme_name

 String

price_pan_name

 String

billing_method

 String

frequency

 String

cycle_day

 Number

binding_period

 String

binding_start_date

 Date

binding_end_date

 Date

agreement_date

 Date

effective_date

 Date

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

subscription_location

Field

Type

type

String

postal_code

String

street_name

String

area

String

town

String

district

String

municipality

String

country

String

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

service

Field

Type

product

(code)

Single Data Object

life_cycle_state

String

life_cycle_state_start_date

Date

date_added

Date

date_removed

Date

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


Expand
titleservice reference data objects

product

Field

Type

type

 String



installed_item

Field

Type

serial_number

String

product

(code)

Single Data Object

date_added

Date

date_removed

Date

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


Expand
titleinstalled_item reference data objects

product

Field

Type

type

 String



applied_process

Field

Type

name

String

applied_datebefore

Date 
applied_afterDate 


bill

Field
Type
numberString
classificationString
life_cycle_stateString
from_dateDate
to_dateDate
due_dateDate
total_credit_amountNumber
total_debit_amountNumber
total_billed_amountNumber
total_amount_to_be_paidNumber
outstanding_amountNumber
unsettled_amountNumberstatus_amountNumber
statusString
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

billing_address

Field

Type

type

String

postal_code

String

street_name

String

area

String

town

String

district

String

municipality

String

country

String

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

billingpresentment_addresspreference

FieldType
typepresentment_methodString

postal_code

String

street_name

String

area

String

town

String

district

String

municipality

String

country

String

active

Boolean

payment_preference

FieldType
payment_methodString

used_for_recurring_payments

Boolean

opt_in_for_subscriptions

Boolean

opt_in_for_purchases

Boolean

wallet

This information only refers to 'Effective' wallets.

FieldType
numberNumber

balance

Number
estimated_consumption_daysNumber
estimated_consumption_dateNumber
last_transaction_date

Date

The date that the last transaction was created

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date
presentment_preference

assets

FieldType

product

(code)

Single Data Object


Expand
titleassets reference data objects

product

Field

Type

type

 String


owned_by_group

FieldType
numberString
nameString
alternative_codeString


 

bill


 

FieldType
number
presentment_method

wallet

This information only refers to 'Effective' wallets.

FieldTypenumberNumber

balance

Numberestimated_consumption_daysNumberestimated_consumption_dateNumber
String
accounts_receivableSingle Data Object
classificationString

active

Boolean
life_cycle_stateString
from_dateDate
to_dateDate
due_dateDate
total_credit_amountNumber
total_debit_amountNumber
total_billed_amountNumber
total_amount_to_be_paidNumber
outstanding_amountNumber
unsettled_amountNumber
statusString
communication_queueSet Data Object
udf_string_1 - udf_string_
4
8String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

assets

FieldType

product

(code)

Single Data Object

 


 

assets

product

Expand
title
bill reference data objects

Field

Type

type

 String

 

bill

 

accounts_receivable

FieldType
numberString
accounts_receivableSingle Data ObjectclassificationStringlife_cycle_stateStringfrom_dateDateto_dateDatedue_dateDatetotal_credit_amountNumbertotal_debit
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber
total_billed_amountNumbertotal_amount_to_be_paidNumberoutstanding_amountNumberunsettled_amountNumberstatusStringcommunication_queueSet Data Object

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_
8
4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4
Date
Date

communication_queue

FieldType
external_systemString
life_cycle_stateString
directionString
mediaString
categoryString
created_dateDate
error_codeString


 

activity 




FieldType
expand

accounts_receivable

FieldTypenumberStringname
number
titlebill reference data objects
Boolean
String

type

(name)

String

status

(name)

String

category

(name)

String
life_cycle_stateString
balanceNumberoutstanding_amountNumber

classification

(name)

Stringcredit_limit_statusStringprimary_accountBoolean

is_parent_account

Boolean

is_partner_account

contact_informationSingle Data Object
start_dateDate
estimated_completion_dateDate
actual_completion_dateDate
serviceSet Data Object

owned_by_group

Set Data Object
udf_string_1 - udf_string_
4
16String
udf_float_1 - udf_float_
4
10Float
udf_date_1 - udf_date_
4
10Date
communication_queue

 


 

Expand
titleactivity reference data objects

contact_information

mediacategory
FieldType
external_systemtypeString
life_cycle_stateStringdirection
nameString
first_nameString
middle_nameString
createdlast_datenameStringDate
error_code

category

(name)

String
gender

 

activity 

FieldTypenumberString

type

(name)

String

status

(name)

String

category

(name)

Stringlife_cycle_stateStringcontact_informationSingle Data Objectstart_dateDateestimated_completion_dateDateactual_completion_dateDateserviceSet Data Object

owned_by_group

Set Data Object
String
day_of_birthNumber
month_of_birthNumber
year_of_birthNumber
name_day_dayNumber
name_day_monthNumber
name_day_date

Date

The name day date within the current year, for example, if the name day is 24/04 then if this tag is used within 2018, it should retrieve 24/04/2018

industry

(name)

String

industry_sector

(name)

String
udf_string_1 - udf_string_
16
4String
udf_float_1 - udf_float_
10
4Float
udf_date_1 - udf_date_
10
4Date

 

 

Expand
titleactivity reference data objects
contact_information


service

FieldType

product

(code)

String
date_addedDate


owned_by_group

last_name
FieldType
typenumberString
nameString
lifealternative_cycle_statecodeString
nameString
first_nameString
middle_nameString


 

job




FieldType
numberString

type

(name)

String

status

(name)

String

category

(name)

String
genderbirthday
life_cycle_stateString
day_of_birthNumbermonth_of_birthNumberyear_of_birthNumberString
accounts_receivableSingle Data Object
subscription

Single Data Object

start_dateDate
estimated_completion_dateDate
actual_completion_dateDate
expiration_date

Date

birthday_current_year_date

Date

name_day_dayNumbername_day_monthNumber

industry

(name)

String

industry_sector

(name)


physical_goodSet Data Object
expenseSet Data Object
subscription_physical_good

Set Data Object


subscription_service

Set Data Object


subscription_expense

Set Data Object


billing_termsSet Data Object

owned_by_group

Set Data Object
udf_string_1 - udf_string_
4
16String
udf_float_1 - udf_float_
4
8Float
udf_date_1 - udf_date_
4
8Date
service

 

Expand
titlejob reference data objects

accounts_receivable

FieldType
numberproductString
(code)nameString
datelife_cycle_addedstateDateString
 
balance
job
Number
Fieldtype
outstanding_amount
TypenumberString(name)
Number

classification

(name)

String

status

expiration_date
credit_limit_statusString

category

(name)

Stringlife_cycle_stateStringaccounts_receivableSingle Data Objectsubscription

Single Data Object

start_dateDateestimated_completion_dateDateactual_completion_dateDateexpenseSet
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

physical_good

Set Data Object
FieldType

product

(code)

Single Data Object
subscription_
date_addedDate


Expand
titlephysical_good

Set Data Object

subscription_service

Set Data Object

subscription_expense

Set Data Object

billing_termsSet Data Object

owned_by_group

Set Data Objectudf_string_1 - udf_string_16Stringudf_float_1 - udf_float_8Floatudf_date_1 - udf_date_8Date

 

Expand
titlejob reference data objects

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

physical_good

FieldType

product

(code)

Single Data Object
date_addedDate
Expand
titlephysical_good reference data objects

product

Field

Type

type

 String

expense

FieldType
serial_numberString

product

(code)

String
date_addedDate

subscription_physical_good

FieldType

product

(code)

Single Data Object
date_addedDate
Expand
titlesubscription_physical_good reference data objects

product

Field

Type

type

 String

subscription_service

FieldType

product

(code)

String
date_addedDate

subscription_expense

FieldType

product

(code)

String
date_addedDate

billing_terms

FieldType
unified_number String
scheme_name String
price_pan_name String
agreement_date Date
effective_date Date
expiration_date Date

 

rewards_participant 

FieldTypenumberStringaccounts_receivableSingle Data Objectsign_up_dateDate

sign_up_unit

(name)

Stringparticipating_reward_schemeSet Data Object

owned_by_group

Set Data Object

life_cycle_state

String
reference data objects

product

Field

Type

type

 String



expense

FieldType
serial_numberString

product

(code)

String
date_addedDate


subscription_physical_good

FieldType

product

(code)

Single Data Object
date_addedDate


Expand
titlesubscription_physical_good reference data objects

product

Field

Type

type

 String



subscription_service

FieldType

product

(code)

String
date_addedDate


subscription_expense

FieldType

product

(code)

String
date_addedDate


billing_terms

FieldType
unified_number String
scheme_name String
price_pan_name String
agreement_date Date
effective_date Date
expiration_date Date


owned_by_group

FieldType
numberString
nameString
alternative_codeString


 

rewards_participant 




FieldType
numberString
accounts_receivableSingle Data Object
sign_up_dateDate

sign_up_unit

(name)

String
participating_reward_schemeSet Data Object

owned_by_group

Set Data Object

access_token

Set Data Object

life_cycle_state

String
udf_string_1 - udf_string_8String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


 

Expand
titlerewards participant reference data objects

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

contact_information

Single Data Object

is_parent_account

Boolean

is_partner_account

Boolean

wallet

Single Data Object

Note: Only refers to 'Effective' wallets

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


Expand
titleaccounts receivable reference data objects

wallet

This information only refers to 'Effective' wallets.

FieldType
numberNumber

balance

Number

alternative_balance

Number

estimated_consumption_daysNumber
estimated_consumption_dateNumber
udf_string_1 - udf_string_
8
4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

 

Single Data Object

Note: Only refers to 'Effective' wallets
Expand
titlerewards participant reference data objects

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean

wallet

wallet

This information only refers to 'Effective' wallets.

contact_information

Field

Type

typeString
life_cycle_stateString
nameString
first_nameString
middle_nameString
last_nameString

category

(name)

String
genderString
day_of_birthNumber
month_of_birthNumber
year_of_birthNumber
name_day_dayNumber
name_day_monthNumber
name_day_date

Date

The name day date within the current year, for example, if the name day is 24/04 then if this tag is used within 2018 then this tag should retrieve 24/04/2018

industry

(name)

String

industry_sector

(name)

String
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date
Expand
titleaccounts receivable reference data objects



participating_reward_scheme

Field

Type

number

name

Number

String

balance

alternative_code

Number

String

estimated

sign_

consumption

up_

days

date

Number

Date

estimated

sign_

consumption_dateNumber

up_unit

(name)

String

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date
participating


owned_

reward

by_

scheme

group

sign_up_unit
FieldType
numberString
nameString
alternative_codeString

sign_up_date

Date


access_token

Date

Field

Type

classification

(name)

String

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4

life_cycle_state

String


 

award_reward_transaction 




FieldType
numberString
rewards_participantSet Data Object
submitted_dateDate

amount

Number
alternative_amount

Number

reward_offerSingle Data Object
initiated_currency

Single Data Object

 


 

Expand
titleaward reward transaction reference data objects

rewards_participant

FieldType
numberString
sign_up_dateDate

sign_up_unit

(name)

String
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

reward_offer

Field

Type

number

String

name

String

alternative_code

String

scheme

(name)

String

type

(name)

String

udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

initiated_currency

Field

Type

code

String


 

spend_reward_transaction 




FieldType
numberString
rewards_participantSet Data Object

total_amount

Number
total_alternative_amount

Number

submitted_dateDate

submitted_by_unit

(name)

String

initiated_currency

Single Data Object

 


Expand
titlespend reward transaction reference data objects

rewards_participant

FieldType
numberString
sign_up_dateDate

sign_up_unit

(name)

String
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

initiated_currency

Field

Type

code

String


 

leads




Field
Type
start_dateDate

expected_completion_date

Date
actual_completion_dateDate

owned_by_group

Set Data Object
accounts_receivable_nameSingle Data Object
accounts_receivable_numberSingle Data Object
numberString

type

(name)

String

status

(name)

String

category

(name)

String
life_cycle_stateString
importance_levelString
priority_levelString

source_type

(name)

String
source_nameString

product_of_interest.code

(code)

String

product_type_of_interest.name

(name)

String

product_family_of_interest.name

(name)

String

product_brand_of_interest.name

(name)

String

subscription_package_name

(name)

String
team.usernameString
team.emailString

competitor.name

(name)

String
udf_date_1 - udf_date_8Date
udf_float_1 - udf_float_8Float
udf_string_1 - udf_string_26String

 

service_request




FieldType
numberString

type

(name)

String

status

(name)

String

category

(name)

String

classification

(name)

String
life_cycle_stateString
accounts_receivableSingle Data Object
urgency_levelString
impact_levelString
priority_levelString
start_dateDate
estimated_completion_dateDate
actual_completion_dateDate
response_dateDate
response_categoryString
temporary_resolution_categoryString
temporary_resolved_byString
temporary_resolution_dateDate
temporary_resolution_accepted_byString
final_resolution_categoryString
final_resolution_resolved_byString
final_resolution_accepted_byString
final_resolution_dateDate
physical_goodSet Data Object
servicesSet Data Object

owned_by_group

Data Object
udf_string_1 - udf_string_16String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_12Date

 


 

Expand
titleservice_request reference data objects

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

physical_good

FieldType
serial_numberString

product

(code)

String
date_addedDate
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

services

FieldType

product

(code)

String
date_addedDate
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

owned_by_group

FieldType
numberString
nameString
alternative_codeString


 

payment_gateway_card 


recurring_payments
FieldType

payment_gateway_provider

(name)

String
expiration_monthNumber
expiration_dateNumber
brandString
typeString
address_line_1_check_resultString
address_zip_check_resultString
security_code_check_resultString
created_dateDate
updated_dateDate
defaultBooleanused

used_for_recurring_payments

Boolean

opt_in_for_subscriptions

Boolean

opt_in_for_

purchases

Boolean


 

Info

Only the cards which are related with an accounts receivable payment preference which is used for recurring payments are retrieved. 

 

payment_gateway_request


FieldType

payment_gateway_provider

(name)

String
life_cycle_stateString

process_run

(number)

String
created_dateDate
execution_dateDate

updated_date

Date

type

String

process_name

String

The options should be EXECUTE_NORMAL_BILLING_RUN, MANUAL

 

payment


FieldType
numberString
reference_numberString

type

(name)

String

payment_method

(name)

String

category

(name)

String
posted_dateDate
amountNumber
accounts_receivableSingle Data Object
voucherSingle Data Object
communicationSet Data Object
udf_string_1 - udf_string_8String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

 


 

Expand
titlepayment reference data objects

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

voucher

FieldType

type

(name)

String

lot

(number)

String
valueNumber
life_cycle_stateString
classificationString
udf_string_1 - udf_string_48String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

communication

FieldType
directionString

media

String
categoryString
life_cycle_stateString
created_dateDate
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


 


 

Info

Only 'Posted' payments are retrieved.

 

buy_in_advance_request


Additional information
FieldType
numberString
durationNumber
duration_unit_of_time

String

Supported values are DAYS, WEEKS, MONTHS, YEARS

created_dateDate
billing_effective_dateDate
expiration_dateDate
billing_state

String

As from CRM.COM R9.0.0 billing_state is replaced by rating_state but remains available for backwards compatibility. The logic is updated to work based on rating_state logic.

rating_state

StringReplaces binding_state

Supported values are RATED, NOT_RATED

life_cycle_stateString
subscriptionSet Data Object
udf_string_1 - udf_string_8String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

 


 

Expand
titlebuy_in_advance_request reference data objects

subscription

Field
Type

type

(name)

String
life_cycle_stateString
numberString
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


 

wallet


FieldType
numberString
estimated_consumption_daysNumber
estimated_consumption_dateDate
estimated_consumption_as_of_dateDate
balanceNumber
alternative_balance

Number

opening_balanceNumber
opening_alterntive_balance

Number

opening_balance_dateDate
life_cycle_stateString
last_transaction_dateDate (The date that the last transaction was created)
udf_string_1User Defined Field 1 of type String
udf_string_2User Defined Field 2 of type String
udf_string_3User Defined Field 3 of type String
udf_string_4User Defined Field 4 of type String
udf_string_5User Defined Field 5 of type String
udf_string_6User Defined Field 6 of type String
udf_string_7User Defined Field 7 of type String
udf_string_8User Defined Field 8 of type String
udf_float_1User Defined Field 1 of type Float
udf_float_2User Defined Field 2 of type Float
udf_float_3User Defined Field 3 of type Float
udf_float_4User Defined Field 4 of type Float
udf_date_1User Defined Field 1 of type Date
udf_date_2User Defined Field 2 of type Date
udf_date_3User Defined Field 3 of type Date
udf_date_4User Defined Field 4 of type Date

 


 

Expand
titlewallet reference data objects

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


 

wallet_transaction


FieldType

type

(name)

String
numberString
amountNumber
alternative_amount

Number

extra_added_amountNumber
extra_added_alternative_amount

Number

life_cycle_stateString
caused_by_entityString
walletData Object
initiated_currency

Data Object

udf_string_1 - udf_string_20String
udf_float_1 - udf_float_12Float
udf_date_1 - udf_date_12Date

 


 

Expand
titlewallet_transaction reference data objects

wallet

FieldType
numberString

initiated_currency

FieldType
codeString


 

write_off


FieldType

type

(name)

String

category

(name)

String
numberString
life_cycle_stateString
issued_onDate
posted_onDate
total_amountNumber
accounts_receivableData Object

 


 

Expand
titlewrite_off reference data objects

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


 

credit_note


FieldType

type

(name)

String

category

(name)

String
numberString
life_cycle_stateString
discount_amountNumber
vat_amountNumber
tax_amountNumber
net_amountNumber
total_amountNumber
issued_onDate
posted_onDate
accounts_receivableData Object
udf_string_1 - udf_string_8String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

 

Expand
titlecredit_note reference data objects

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


 

invoice


FieldType

type

(name)

String

category

(name)

String
numberString
life_cycle_stateString
discount_amountNumber
vat_amountNumber
tax_amountNumber
net_amountNumber
total_amountNumber
outstanding_amountNumber
unsettled_amountNumber
issued_onDate
posted_onDate
due_onDate
accounts_receivableDate Object
udf_string_1 - udf_string_8String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date

 


 

Expand
titleinvoice reference data objects

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


 

invoice_cancellation


FieldType

type

(name)

String

category

(name)

String
numberString
life_cycle_stateString
issued_onDate
posted_onDate
total_amountNumber
accounts_receivableData Object

 


 

Expand
titleinvoice_cancellation reference data objects

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


 


 

payment_cancellation 


FieldType

type

(name)

String

category

(name)

String
numberString
life_cycle_stateString
issued_onDate
posted_onDate
payment_amountNumber
accounts_receivableData Object

 


 

Expand
titlepayment_cancellation reference data objects

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


 

refund


FieldType

type

(name)

String

category

(name)

String

refund_method

(name)

String
numberString
life_cycle_stateString
refund_amountNumber
issued_onDate
posted_onDateprocessed_by_payment_gatewayString
payment_gateway_reference_numberString
accounts_receivableData Object


 

Expand
titlerefund reference data objects

accounts_receivable

FieldType
numberString
nameString
life_cycle_stateString
balanceNumber
outstanding_amountNumber

classification

(name)

String
credit_limit_statusString
primary_accountBoolean

is_parent_account

Boolean

is_partner_account

Boolean
udf_string_1 - udf_string_4String
udf_float_1 - udf_float_4Float
udf_date_1 - udf_date_4Date


 

subscription_action



Field
Type

number

String
subscription_numberString
typeString
sub_typeString
behavior_codeString
classification_codeString
executed_dateDate
scheduled_dateDate
udf_string_1User Defined Field 1 of type String
udf_string_2User Defined Field 2 of type String
udf_string_3User Defined Field 3 of type String
udf_string_4User Defined Field 4 of type String
udf_string_5User Defined Field 5 of type String
udf_string_6User Defined Field 6 of type String
udf_string_7User Defined Field 7 of type String
udf_string_8User Defined Field 8 of type String
udf_float_1User Defined Field 1 of type Float
udf_float_2User Defined Field 2 of type Float
udf_float_3User Defined Field 3 of type Float
udf_float_4User Defined Field 4 of type Float
udf_date_1User Defined Field 1 of type Date
udf_date_2User Defined Field 2 of type Date
udf_date_3User Defined Field 3 of type Date
udf_date_4User Defined Field 4 of type Date


 



Ui expand
titleUseful Links

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
cqllabel = "global" and space = "V4Manual"
labelsglobal



Column
width20%


Panel

On this page

Table of Contents
maxLevel3


Panel

Release news

Check out a full list of CRM.COM features available per release.

Ui button
colorturquoise
newWindowtrue
iconinfo
titleFeatures
urlhttps://discover.crm.com/display/V4ReleaseNotes/Features

Check out upgrade notes to find out what needs to be done to upgrade from your current release to the latest release of CRM.COM.

Ui button
colorturquoise
newWindowtrue
iconinfo
titleUpgrade Notes
urlhttps://discover.crm.com/display/V4ReleaseNotes/Upgrade+Notes



...