pricing_agreement

 pricing_agreement object response data

Name

Type

Description

price_planPrice Plan ObjectThe price plan that was agreed for the specific accounts receivable
usage_service_catalogUsage Service Catalog Object

The usage service catalog that was agreed for the specific accounts receivable

Deprecated from CRM.COM R15.0.0


additive_discount_definitions_setSet of Additive Discount Definition Objects

A list of Additive discount definitions that can only be applied when the specific accounts receivable is billed.

Available from CRM.COM R14.9.0

Referred Objects Response Data

 price_plan object data response
NameType Description
IdStringThe ID of the retrieved price plan
nameStringThe Name of the retrieved price plan
codeStringThe Code of the retrieved price plan
descriptionStringThe Description of the retrieved price plan
typeStringThe Type of the retrieved price plan which can be BASE or CONDITIONAL
effective_date DateThe Effective Date of the retrieved price plan
expiration_date Date

The Expiration Date of the retrieved price plan

currencyCurrency Object

The Currency of the retrieved price plan

Available from CRM.COM R14.2.0

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 usage_service_catalog object data response
NameType Description
IdStringThe ID of the retrieved usage service catalog
nameStringThe Name of the retrieved usage service catalog
alternative_codeStringThe Alternative Code of the retrieved usage service catalog
descriptionStringThe Description of the retrieved usage service catalog
effective_dateDate

The Effective Date of the retrieved usage service catalog

Available from CRM.COM R14.0.0

expiration_dateDate

The Expiration Date of the retrieved usage service catalog

Available from CRM.COM R14.0.0


 additive_discount_definition object response data

Name

Type

Description

id

String

The ID of the retrieved additive discount definition

alternative_codeStringThe alternative code of the retrieved additive discount definition
nameStringThe name of the retrieved additive discount definition
life_cycle_stateString

The life cycle state of the retrieved additive discount definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE

classificationString

The classification of the retrieved additive discount definition which can be either SUBSCRIPTIONS, JOBS or GENERAL

GENERAL classification available from CRM.COM R15.0.0

JOB classification is not available from CRM.COM R17.0.0

typeStringThe type of the additive discount definition which can be AUTO_APPLY or AD_HOC