- Created by Georgia Kountouri, last modified by George Rossides on May 05, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 4 Next »
Name | Type | Description |
---|---|---|
id | String | The id of the physical good sale |
sales_method | String | The sales method that was used while selling the installed item, which can be DIRECT_SALE, INDIRECT_SALE, PRE_SALE or TRANSFER_OWNERSHIP TRANSFER_OWNERSHIP sales method is available from CRM.COM R13.0.0 |
performed_date | Date | The date that the installed item was provided to the customer |
return_date | Date | The date on which the purchased physical good was returned or replaced |
transfer_date | Date | The date on which the purchased physical good's ownership was transferred to another account owner Available from CRM.COM R13.0.0 |
accounts_receivable | Accounts Receivable Object | The Accounts Receivable that owns or used to own the specified physical good. Available from CRM.COM R13.0.0 |
ownership_transferred_to | Accounts Receivable Object | The Accounts Receivable to which the purchased physical good's ownership was transferred to. Applicable only if sales method is set to Transfer of Ownership. Available from CRM.COM R13.0.0 |
ownership_transferred_from
| Accounts Receivable Object | The Accounts Receivable from which the purchased physical good's ownership was transferred from. Applicable only if sales method is set to Transfer of Ownership. Available from CRM.COM R13.0.0 |
performed_by_user | User Object | The user that provided the installed item to the customer |
returned_by_user | User Object | The user that performed the physical good's return or replacement |
transferred_by_user | User Object | The user that performed the physical good's transfer of ownership to another account owner Available from CRM.COM R13.0.0 |
product | Product Object | The purchased physical good |
installed_item | Installed Item Object | The purchased installed item |
invoice | Invoice Object | The invoice that was posted for the purchased physical good |
credit_note | Credit Note Object | The credit note that was posted when the purchased physical good is returned. |
stock_out_warehouse_transaction | Warehouse Transaction Object | The stock out warehouse transaction that was applied in order to move the installed item out of the warehouse while selling it to the customer |
stock_in_warehouse_transaction | Warehouse Transaction Object | The stock in warehouse transaction that was applied in order to move back to a warehouse a purchased physical good which is returned by the customer |
job | Job Object | The Job through which the physical goods was sold to the account owner |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
Name | Type | Description |
---|---|---|
Id | String | The ID of the product |
code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
priority_level | Integer | The priority level of the product Available from CRM.COM R12.3.0 |
global_rate | Global Rate Object | The global rate of the retrieved product Available from CRM.COM R15.0.0 |
product_type | Product type object | The type of the product |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
Id | String | The ID of the retrieved product type |
name | String | The Name of the retrieved product type |
alternative_code | String | The Alternative Code of the retrieved product type |
description | String | The Description of the retrieved product type |
classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
Id | String | The ID of the retrieved usage detail record type |
name | String | The Name of the retrieved usage detail record type |
alternative_code | String | The Alternative Code of the retrieved usage detail record type |
description | String | The Description of the retrieved usage detail record type |
unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
Name | Type | Description |
id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
alternative_code | String | The alternative code of the Unit of measurement |
Name | Type | Description |
---|---|---|
Id | String | The ID of the retrieved meter reading type |
name | String | The Name of the retrieved meter reading type |
alternative_code | String | The Alternative Code of the retrieved meter reading type |
classification | String | The Classification of the retrieved meter reading type |
description | String | The Description of the retrieved meter reading type |
unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
Name | Type | Description |
id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
alternative_code | String | The alternative code of the Unit of measurement |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved rate |
rate_model | String | The price plan rate model which can be one of the following:
From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED |
global_base_amount | Number | The base price of the product in the Global Price Plan |
base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between
|
uot | String | The 'UOT' applicable for the rate
Available for one-time services |
time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved installed item |
serial_number | String | The serial number of the retrieved installed item |
alternative_code | String | The alternative code of the retrieved installed item |
state | String | The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE |
state_classification | State Classification object | The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0 |
Product object | The product of the retrieved installed item |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
Id | String | The ID of the product |
code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
priority_level | Integer | The priority level of the product Available from CRM.COM R12.3.0 |
global_rate | Global Rate Object | The global rate of the retrieved product Available from CRM.COM R15.0.0 |
product_type | Product type object | The type of the product |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
Id | String | The ID of the retrieved product type |
name | String | The Name of the retrieved product type |
alternative_code | String | The Alternative Code of the retrieved product type |
description | String | The Description of the retrieved product type |
classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
Id | String | The ID of the retrieved usage detail record type |
name | String | The Name of the retrieved usage detail record type |
alternative_code | String | The Alternative Code of the retrieved usage detail record type |
description | String | The Description of the retrieved usage detail record type |
unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
Name | Type | Description |
id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
alternative_code | String | The alternative code of the Unit of measurement |
Name | Type | Description |
---|---|---|
Id | String | The ID of the retrieved meter reading type |
name | String | The Name of the retrieved meter reading type |
alternative_code | String | The Alternative Code of the retrieved meter reading type |
classification | String | The Classification of the retrieved meter reading type |
description | String | The Description of the retrieved meter reading type |
unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
Name | Type | Description |
id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
alternative_code | String | The alternative code of the Unit of measurement |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved rate |
rate_model | String | The price plan rate model which can be one of the following:
From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED |
global_base_amount | Number | The base price of the product in the Global Price Plan |
base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between
|
uot | String | The 'UOT' applicable for the rate
Available for one-time services |
time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
Name | Type | Description |
---|---|---|
name | String | The name of the installed item's state classification |
alternative_code | String | The alternative code of the installed item's state classification |
description | String | The description of the installed item's state classification |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved invoice |
number | String | The number of the retrieved invoice |
reference_number | String | The reference number of the retrieved invoice |
life_cycle_state | String | The life cycle state of the invoice. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED |
issued_on | Date | The date that the invoice was issued |
posted_on | Date | The date that the invoice was posted |
due_on | Date | The date that the credit period for that specific invoice is ending. |
total_amount | Number | The total amount of the invoice |
outstanding_amount | Number | The total outstanding amount of the invoice |
unsettled_amount | Number | The total unsettled amount of the invoice |
currency_rate_period | Currency Rate Period object | The currency rate period based on which the invoice's amounts were calculated Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency rate period |
rate | Number | The exchange rate of the currency rate period |
inverse_rate | Number | The inverse exchange rate of the currency rate period |
from_date | Date | The date from which the exchange rate is valid |
to_date | Date | The date until which the exchange rate is valid |
currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency |
code | String | The code of the retrieved currency |
prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
integer_part_name | String | The integer part name for the specified currency |
decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved credit note |
number | String | The number of the retrieved credit note |
reference_number | String | The reference number of the retrieved credit note |
life_cycle_state | String | The life cycle state of the credit note. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED |
issued_on | Date | The date that the credit note was issued |
posted_on | Date | The date that the credit note was posted |
total_amount | Number | The total amount of the credit note |
currency_rate_period | Currency Rate Period object | The currency rate period based on which the credit note's amounts were calculated Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency rate period |
rate | Number | The exchange rate of the currency rate period |
inverse_rate | Number | The inverse exchange rate of the currency rate period |
from_date | Date | The date from which the exchange rate is valid |
to_date | Date | The date until which the exchange rate is valid |
currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency |
code | String | The code of the retrieved currency |
prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
integer_part_name | String | The integer part name for the specified currency |
decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
id | String | The ID of the warehouse transaction that was created |
number | String | The number of the warehouse transaction that was created
|
batch_number | String | The batch_number of the warehouse transaction that was created |
life_cycle_state | String | The stated of the transaction which can be DRAFT or POSTED |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved job |
number | String | The number of the retrieved job |
description | String | The description of the retrieved job |
life_cycle_state | String | The life cycle state of the retrieved job The supported options are
|
rating_state | String | The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0 |
Accounts Receivable object | The accounts receivable related with the specified job | |
type | Job type object | The type information of the retrieved job Available from CRM.COM R11.2.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
---|---|---|
Id | String | The ID of the retrieved job type |
name | String | The Name of the retrieved job type |
alternative_code | String | The Alternative Code of the retrieved job type |
description | String | The Description of the retrieved job type |
billing_directive | String | The billing directive of the retrieved job type The supported billing directive options are
Available from CRM.COM R10.0.0 |
billing_method | String | The billing method of the retrieved job type. Applicable only for billable job types with fulfillment scope GENERIC_PURPOSE The supported billing methods are
Available from CRM.COM R10.0.0 From CRM.COM R15.0.0 and onward, this attribute will be deprecated |
fulfillment_scope | String | The fulfillment scope of the retrieved job type The supported fulfillment scopes are
The following fulfillment scopes will be available from CRM.COM R8.0.0 ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION The following fulfillment scopes will be available from CRM.COM R9.0.0 SWAP_SUBSCRIPTION_SERVICES, SWAP_SUBSCRIPTION_INSTALLED_ITEMS The following fulfillment scope will be available from CRM.COM R11.0.0 REPLACE_PHYSICAL_GOODS From CRM.COM R15.0.0 and onward, all fulfillment scopes will be deprecated |
fulfillment_method | String | The fulfillment method of the retrieved job type The supported fulfillment methods are
From CRM.COM R15.0.0 and onward, this attribute will be deprecated |
- No labels