communication_referring_to object parameter data

Name

Type

Description

subscription_identifier

(optional)

Subscription Identifier

The subscription which is related with the communication. The allowed subscription identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

activity_identifier

(optional)

Activity Identifier

The activity which is related with the communication. The allowed activity identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the activity

number

(semi-optional)

String

The number of the activity

job_identifier

(optional)

Job Identifier

The job which is related with the communication. The allowed job identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the job

number

(semi-optional)

String

The number of the job

communication_identifier

(optional)

Communication Identifier

The communication which is related with the communication. The allowed communication identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the communication

number

(semi-optional)

String

The number of the communicaiton

accounts_receivable_identifier

(optional)

Accounts Receivable Identifier

The accounts receivable which is related with the communication. The allowed accounts receivable identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

bill_identifier

(optional)

Bills Identifier

The bill which is related with the communication. The allowed bill identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the bill

number

(semi-optional)

String

The number of the bill

notification_identifier

(optional)

Notification Identifier

The notification which is related with the communication. The allowed notification identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the notification

number

(semi-optional)

String

The number of the notification

rewards_participant_identifier

(optional)

Rewards Participant Identifier

The rewards participant which is related with the communication. The allowed rewards participant identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the rewards participant

number

(semi-optional)

String

The number of the rewards participant

access_token_identifier

(semi-optional)

Access Token Identifier

The identifier of the access token which is related with the rewards participant. Only effective access tokens can be used to identify a rewards participant. The allowed access token identifier fields are the following:

Name	Type	Description
authentication_code (semi-optional)	String	The authentication code of the access token
identifier (semi-optional)	String	The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code
pass_code (mandatory on conditions)	String	The pass code of the access token, which is applicable and mandatory if the identifier is specified
one_time_password (semi-optional)	Integer	The one-time password (OTP) of the access token Available from CRM.COM R13.0.0

award_reward_transaction_identifier

(optional)

Award Reward Transaction Identifier

The award reward transaction which is related with the communication. The allowed award reward transaction identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the award reward transaction

number

(semi-optional)

String

The number of the award reward transaction

spend_reward_transaction_identifier

(optional)

Spend Reward Transaction Identifier

The spend reward transaction which is related with the communication. The allowed spend reward transaction identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the spend reward transaction

number

(semi-optional)

String

The number of the spend reward transaction

service_request_identifier

(optional)

Service Request Identifier

The service request which is related with the communication. The allowed service request identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the service request

number

(semi-optional)

String

The number of the service request

lead_identifier

(optional)

Lead Identifier

The lead which is related with the communication. The allowed lead identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the lead

number

(semi-optional)

String

The number of the lead

payment_identifier

(optional)

Payment Identifier

The payment which is related with the communication. The allowed payment identifier fields are the following:

Name	Type	Description
id (semi-optional)	String	The ID of the payment
number (semi-optional)	String	The number of the payment
reference_number (semi-optional)	String	The reference number of the payment
back_office_code (semi-optional)	String	The back office code of the payment Available from CRM.COM R9.1.0

Available from CRM.COM R7.0.0

refund_identifier

(optional)

Refund Identifier

The refund which is related with the communication. The allowed refund identifier fields are the following:

Name	Type	Description
id (semi-optional)	String	The ID of the refund
number (semi-optional)	String	The number of the refund
reference_number (semi-optional)	String	The reference number of the refund
back_office_code (semi-optional)	String	The back office code of the refund Available from CRM.COM R9.1.0

Available from CRM.COM R13.0.0

payment_gateway_card_identifier

(optional)

Payment Gateway Card Identifier

The payment gateway card which is related with the communication. The allowed payment gateway card identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The id of the payment gateway card

payment_gateway_reference_number

(semi-optional)

String

The card's reference number as provided by the payment gateway

last_digits

(semi-optional)

String

The last digits of the card as provided by the payment gateway provider

Available from CRM.COM R7.0.0

payment_gateway_request_identifier

(optional)

Payment Gateway Request Identifier

The payment gateway request which is related with the communication. The allowed payment gateway request identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The id of the payment gateway request

number

(semi-optional)

String

The number of the retrieved payment gateway request

Available from CRM.COM R7.0.0

buy_in_advance_request_identifier

(optional)

Buy in Advance Request Identifier

The buy in advance request which is related with the communication. The allowed buy in advance request identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the buy in advance request

number

(semi-optional)

String

The number of the buy in advance request

Available from CRM.COM R8.0.0

access_token_identifier

(optional)

Access Token Identifier

The access token which is related with the communication. The allowed access token identifier fields are the following:

Name

Type

Description

authentication_code

(semi-optional)

String

The authentication code of the access token

identifier

(semi-optional)

String

The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code

pass_code

(mandatory on conditions)

String

The pass code of the access token, which is applicable and mandatory if the identifier is specified

Available from CRM.COM R8.0.0

purchase_customer_event_identifier

(optional)

Purchase Customer Event Identifier

The purchase customer event token which is related with the communication. The allowed purchase customer event identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the customer event

number

(semi-optional)

String

The number of the customer event

external_system_reference_number

(semi-optional)

String

The external system's unique reference number for the customer event

Available from CRM.COM R10.1.0

Available from CRM.COM R13.0.0

spend_request_customer_event_identifier

(optional)

Spend Request Customer Event Identifier

The spend request customer event token which is related with the communication. The allowed spend request customer event identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the customer event

number

(semi-optional)

String

The number of the customer event

external_system_reference_number

(semi-optional)

String

The external system's unique reference number for the customer event

Available from CRM.COM R10.1.0

Available from CRM.COM R13.0.0

invoice_identifier

(optional)

Invoice Identifier

The Invoice which is related with the communication. The allowed Invoice identifier fields are the following:

Name	Type	Description
id (semi-optional)	String	The ID of the invoice
number (semi-optional)	String	The number of the invoice
reference_number (semi-optional)	String	The reference number of the invoice
back_office_code (semi-optional)	String	The back office code of the invoice Available from CRM.COM R9.1.0

Available from CRM.COM R14.0.0

credit_wallet_transaction_identifier

Wallet Transaction Identifier

The Credit Wallet Transaction which is related with the communication. The allowed Wallet Transaction Identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the wallet transaction

number

(semi-optional)

String

The number of the wallet transaction

Available from CRM.COM R14.0.0

debit_wallet_transaction_identifier

Wallet Transaction Identifier

The Debit Wallet Transaction which is related with the communication. The allowed Wallet Transaction Identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the wallet transaction

number

(semi-optional)

String

The number of the wallet transaction

Available from CRM.COM R14.0.0

voucher_identifier

Voucher Identifier

The Voucher which is related with the communication. The allowed Voucher Identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the voucher

number

(semi-optional)

String

The number of the voucher

Available from CRM.COM R14.0.0