GET accounts_receivable/assets/list

Available from CRM.COM R10.0.0

From CRM.COM R14.0.0 this method will return the traceable physical goods that are Owned by Customer and do not have a Physical Good Sale against them

This method returns the physical goods assets that were purchased by the specified customer. Multiple assets are retrieved by this call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier  

The identifier of the accounts receivable that should be returned as a result. The allowed accounts receivable identifier fields are the following:

Name

Type

Description

id

(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

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name

Type

Description

idStringThe id of the physical good sale
sales_methodString

The sales method that was used while selling the installed item, which can be DIRECT_SALE, INDIRECT_SALE or PRE_SALE

performed_dateDateThe date that the installed item was provided to the customer
transferred_dateDate

The date on which the purchase physical good's ownership was transferred

Available from CRM.COM R13.0.0

accounts_receivableAccounts Receivable Object

The Accounts Receivable that owns the specified physical good.

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.

Available from CRM.COM R13.0.0


performed_by_user

User Object

The user that provided the installed item to the customer
transferred_by_userUser Object

The user that transferred the ownership of the purchased physical good to this account owner.

Available from CRM.COM R13.0.0

productProduct ObjectThe purchased physical good
installed_itemInstalled Item ObjectThe purchased installed item
invoiceInvoice ObjectThe invoice that was posted for the purchased physical good
stock_out_warehouse_transactionWarehouse 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

jobJob Object

The Job through which the physical goods was sold to the account owner

Available from CRM.COM R11.5.0 and CRM.COM R12.1.0

Referred Objects Response Data

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe 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_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object 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_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object 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_dateDate

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_dateDate

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

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object 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_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 company profile object response data

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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 user object response data

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

email

String

The email of the retrieved user

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 global rate object response data

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:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

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

 installed item object response data

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

stateStringThe state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classificationState 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

Product object

The product of the retrieved installed item

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 global rate object response data

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:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

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

 state classification object response data
Name
Type
Description
nameStringThe 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

 invoice object response data

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_onDateThe date that the invoice was issued
posted_onDateThe date that the invoice was posted
due_onDateThe date that the credit period for that specific invoice is ending.
total_amountNumberThe total amount of the invoice
outstanding_amountNumberThe total outstanding amount of the invoice
unsettled_amountNumberThe total unsettled amount of the invoice
currency_rate_periodCurrency 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

 currency rate period object response data

Name

Type

Description

id

String

The ID of the retrieved currency rate period

rateNumberThe exchange rate of the currency rate period
inverse_rateNumberThe inverse exchange rate of the currency rate period
from_dateDateThe date from which the exchange rate is valid
to_dateDateThe date until which the exchange rate is valid
currencyCurrency ObjectThe Currency with which the returned exchange rate information refers to

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

 warehouse transaction object response data

Name

Type

Description

idString

The ID of the warehouse transaction that was created

number

String

The number of the warehouse transaction that was created

 

batch_number

StringThe batch_number of the warehouse transaction that was created

life_cycle_state

String

 The stated of the transaction which can be DRAFT or POSTED

 job object response data

Name

Type

Description

id

String

The ID of the retrieved job

number

String

The number of the retrieved job 

descriptionStringThe description of the retrieved job 

life_cycle_state

String

The life cycle state of the retrieved job

The supported options are

  • DRAFT
  • PENDING
  • IN PROGRESS
  • COMPLETED
  • CANCELLED
rating_stateString

The rating state of the retrieved subscription that can be PENDING or COMPLETED

Available from CRM.COM R9.0.0

accounts_receivable

Accounts Receivable object

The accounts receivable related with the specified job

typeJob type object

The type information of the retrieved job

Available from CRM.COM R11.2.0


Referred Objects Response Data

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe 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_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object 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_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object 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_dateDate

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_dateDate

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

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object 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_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 company profile object response data

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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 job_type response data object
NameType Description
IdStringThe ID of the retrieved job type
nameStringThe Name of the retrieved job type
alternative_codeStringThe Alternative Code of the retrieved job type
descriptionStringThe Description of the retrieved job type
billing_directiveString

The billing directive of the retrieved job type

The supported billing directive options are

  • BILLABLE
  • NOT_BILLABLE

Available from CRM.COM R10.0.0

billing_methodString

The billing method of the retrieved job type. Applicable only for billable job types with fulfillment scope GENERIC_PURPOSE

The supported billing methods are

  • BILL_ON_STARTING_PROGRESS
  • BILL_ON_COMPLETION

Available from CRM.COM R10.0.0

From CRM.COM R15.0.0 and onward, this attribute will be deprecated

fulfillment_scopeString

The fulfillment scope of the retrieved job type

The supported fulfillment scopes are

  • GENERIC_PURPOSE
  • NEW_SUBSCRIPTION
  • ACTIVATE_SUBSCRIPTION
  • DEACTIVATE_SUBSCRIPTION
  • CANCEL_SUBSCRIPTION
  • ADD_SUBSCRIPTION_SERVICES
  • CANCEL_SUBSCRIPTION_SERVICES
  • CHANGE_SUBSCRIPTION_LOCATION
  • SWAP_SUBSCRIPTION_SERVICES
  • SWAP_SUBSCRIPTION_INSTALLED_ITEMS
  • REPLACE_PHYSICAL_GOODS

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_methodString

The fulfillment method of the retrieved job type

The supported fulfillment methods are

  • BASED_ON_ORDERED_ITEMS
  • BASED_ON_DELIVERED_ITEMS

From CRM.COM R15.0.0 and onward, this attribute will be deprecated

 

Examples

 Example 1

HTTP Method: GET

 

Request:

Response:

    {
        "data":
        [
            {
                "product":
                {
                    "code": "Cables",
                    "product_type":
                    {
                        "service_type": null,
                        "used_for_provisioning": false,
                        "alternative_code": "SP",
                        "composition_method": "FLAT",
                        "name": "Spare Parts",
                        "description": "Spare Parts",
                        "id": "23C3916E974A461B97BBF650546645F7",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "NONTRACEABLE"
                    },
                    "alternative_code": "C_2",
                    "description": null,
                    "id": "A21B1D394871493E8BC40ECF3DD2D579"
                },
                "installed_item": null,
                "performed_date": "2016-06-30T07:03:36",
                "performed_by":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "sales_method": "PRE_SALE",
                "id": "9EC2AF1FF95249A59C5A095E8F05182C",
                "invoice": null,
                "stock_out_warehouse_transaction": null
            },
            {
                "product":
                {
                    "code": "Set-top-box",
                    "product_type":
                    {
                        "service_type": null,
                        "used_for_provisioning": true,
                        "alternative_code": "STB",
                        "composition_method": "FLAT",
                        "name": "SET TOP BOX",
                        "description": "SET TOP BOX",
                        "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "TRACEABLE"
                    },
                    "alternative_code": "STB",
                    "description": null,
                    "id": "D613415339C14975B28BB4FC11598E93"
                },
                "installed_item":
                {
                    "product":
                    {
                        "code": "Set-top-box",
                        "product_type":
                        {
                            "service_type": null,
                            "used_for_provisioning": true,
                            "alternative_code": "STB",
                            "composition_method": "FLAT",
                            "name": "SET TOP BOX",
                            "description": "SET TOP BOX",
                            "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "TRACEABLE"
                        },
                        "alternative_code": "STB",
                        "description": null,
                        "id": "D613415339C14975B28BB4FC11598E93"
                    },
                    "alternative_code": "stbns0001119",
                    "serial_number": "stbns0001119",
                    "id": "670C680DFD33479B96299F3DCD1F251D",
                    "state": "EFFECTIVE"
                },
                "performed_date": "2016-06-30T07:02:55",
                "performed_by":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "sales_method": "DIRECT_SALE",
                "id": "BE34438303A543A8BFA31861B1EB4C9E",
                "invoice": null,
                "stock_out_warehouse_transaction":
                {
                    "number": "700",
                    "batch_number": null,
                    "id": "5221BC0C6C6E47568F602B0757B588D5",
                    "life_cycle_state": "POSTED"
                }
            },
            {
                "product":
                {
                    "code": "Antenna",
                    "product_type":
                    {
                        "service_type": null,
                        "used_for_provisioning": false,
                        "alternative_code": "001",
                        "composition_method": "FLAT",
                        "name": "Equipment",
                        "description": null,
                        "id": "EQ",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "NONTRACEABLE"
                    },
                    "alternative_code": "A",
                    "description": null,
                    "id": "872C558604704AA29D8512A70B608573"
                },
                "installed_item": null,
                "performed_date": "2016-06-30T06:53:58",
                "performed_by":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "sales_method": "PRE_SALE",
                "id": "00E503FF73F645808195E173B91A3E4D",
                "invoice": null,
                "stock_out_warehouse_transaction": null
            },
            {
                "product":
                {
                    "code": "Antenna",
                    "product_type":
                    {
                        "service_type": null,
                        "used_for_provisioning": false,
                        "alternative_code": "001",
                        "composition_method": "FLAT",
                        "name": "Equipment",
                        "description": null,
                        "id": "EQ",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "NONTRACEABLE"
                    },
                    "alternative_code": "A",
                    "description": null,
                    "id": "872C558604704AA29D8512A70B608573"
                },
                "installed_item": null,
                "performed_date": "2016-06-30T07:02:23",
                "performed_by":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "sales_method": "PRE_SALE",
                "id": "D37E63291D2D4A0A8B90AA626050DAE1",
                "invoice": null,
                "stock_out_warehouse_transaction": null
            },
            {
                "product":
                {
                    "code": "Cables",
                    "product_type":
                    {
                        "service_type": null,
                        "used_for_provisioning": false,
                        "alternative_code": "SP",
                        "composition_method": "FLAT",
                        "name": "Spare Parts",
                        "description": "Spare Parts",
                        "id": "23C3916E974A461B97BBF650546645F7",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "NONTRACEABLE"
                    },
                    "alternative_code": "C_2",
                    "description": null,
                    "id": "A21B1D394871493E8BC40ECF3DD2D579"
                },
                "installed_item": null,
                "performed_date": "2016-06-30T07:02:55",
                "performed_by":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "sales_method": "PRE_SALE",
                "id": "92963ECC3D224C32B3A1CF76660962E9",
                "invoice": null,
                "stock_out_warehouse_transaction": null
            },
            {
                "product":
                {
                    "code": "Smartcard",
                    "product_type":
                    {
                        "service_type": null,
                        "used_for_provisioning": true,
                        "alternative_code": "S",
                        "composition_method": "FLAT",
                        "name": "SMARTCARD",
                        "description": "SMARTCARD",
                        "id": "D6BE0209EC0149989A89972CE889DF8B",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "TRACEABLE"
                    },
                    "alternative_code": "S",
                    "description": null,
                    "id": "4F656ED5DAC44168B0805227881202CD"
                },
                "installed_item": null,
                "performed_date": "2016-06-30T07:02:55",
                "performed_by":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "sales_method": "PRE_SALE",
                "id": "4CC2434BB8914E6898301D62BDFD9322",
                "invoice": null,
                "stock_out_warehouse_transaction": null
            },
            {
                "product":
                {
                    "code": "Cables",
                    "product_type":
                    {
                        "service_type": null,
                        "used_for_provisioning": false,
                        "alternative_code": "SP",
                        "composition_method": "FLAT",
                        "name": "Spare Parts",
                        "description": "Spare Parts",
                        "id": "23C3916E974A461B97BBF650546645F7",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "NONTRACEABLE"
                    },
                    "alternative_code": "C_2",
                    "description": null,
                    "id": "A21B1D394871493E8BC40ECF3DD2D579"
                },
                "installed_item": null,
                "performed_date": "2016-06-30T07:02:55",
                "performed_by":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "sales_method": "PRE_SALE",
                "id": "7EFD9137BAE44C2189B82D2705AF90D3",
                "invoice": null,
                "stock_out_warehouse_transaction": null
            },
            {
                "product":
                {
                    "code": "Cables",
                    "product_type":
                    {
                        "service_type": null,
                        "used_for_provisioning": false,
                        "alternative_code": "SP",
                        "composition_method": "FLAT",
                        "name": "Spare Parts",
                        "description": "Spare Parts",
                        "id": "23C3916E974A461B97BBF650546645F7",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "NONTRACEABLE"
                    },
                    "alternative_code": "C_2",
                    "description": null,
                    "id": "A21B1D394871493E8BC40ECF3DD2D579"
                },
                "installed_item": null,
                "performed_date": "2016-06-30T07:02:55",
                "performed_by":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "sales_method": "PRE_SALE",
                "id": "7873477487274FD4B0AE989A394E050B",
                "invoice": null,
                "stock_out_warehouse_transaction": null
            },
            {
                "product":
                {
                    "code": "Smartcard",
                    "product_type":
                    {
                        "service_type": null,
                        "used_for_provisioning": true,
                        "alternative_code": "S",
                        "composition_method": "FLAT",
                        "name": "SMARTCARD",
                        "description": "SMARTCARD",
                        "id": "D6BE0209EC0149989A89972CE889DF8B",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "TRACEABLE"
                    },
                    "alternative_code": "S",
                    "description": null,
                    "id": "4F656ED5DAC44168B0805227881202CD"
                },
                "installed_item": null,
                "performed_date": "2016-06-30T07:02:55",
                "performed_by":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "sales_method": "PRE_SALE",
                "id": "F2B354C5C5924A2DB091B8CDEBBDFE0D",
                "invoice": null,
                "stock_out_warehouse_transaction": null
            },
            {
                "product":
                {
                    "code": "Set-top-box",
                    "product_type":
                    {
                        "service_type": null,
                        "used_for_provisioning": true,
                        "alternative_code": "STB",
                        "composition_method": "FLAT",
                        "name": "SET TOP BOX",
                        "description": "SET TOP BOX",
                        "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "TRACEABLE"
                    },
                    "alternative_code": "STB",
                    "description": null,
                    "id": "D613415339C14975B28BB4FC11598E93"
                },
                "installed_item":
                {
                    "product":
                    {
                        "code": "Set-top-box",
                        "product_type":
                        {
                            "service_type": null,
                            "used_for_provisioning": true,
                            "alternative_code": "STB",
                            "composition_method": "FLAT",
                            "name": "SET TOP BOX",
                            "description": "SET TOP BOX",
                            "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "TRACEABLE"
                        },
                        "alternative_code": "STB",
                        "description": null,
                        "id": "D613415339C14975B28BB4FC11598E93"
                    },
                    "alternative_code": "stbns0001118",
                    "serial_number": "stbns0001118",
                    "id": "7D0A33AA34414EF28999B34BA8E2B91A",
                    "state": "EFFECTIVE"
                },
                "performed_date": "2016-06-30T07:02:55",
                "performed_by":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "sales_method": "DIRECT_SALE",
                "id": "B94D4B5EBED7414CB8407A152FD4B26D",
                "invoice": null,
                "stock_out_warehouse_transaction":
                {
                    "number": "698",
                    "batch_number": null,
                    "id": "4A6360CD9CD140098EB6C790B4ABB61C",
                    "life_cycle_state": "POSTED"
                }
            },
            {
                "product":
                {
                    "code": "Smartcard",
                    "product_type":
                    {
                        "service_type": null,
                        "used_for_provisioning": true,
                        "alternative_code": "S",
                        "composition_method": "FLAT",
                        "name": "SMARTCARD",
                        "description": "SMARTCARD",
                        "id": "D6BE0209EC0149989A89972CE889DF8B",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "TRACEABLE"
                    },
                    "alternative_code": "S",
                    "description": null,
                    "id": "4F656ED5DAC44168B0805227881202CD"
                },
                "installed_item":
                {
                    "product":
                    {
                        "code": "Smartcard",
                        "product_type":
                        {
                            "service_type": null,
                            "used_for_provisioning": true,
                            "alternative_code": "S",
                            "composition_method": "FLAT",
                            "name": "SMARTCARD",
                            "description": "SMARTCARD",
                            "id": "D6BE0209EC0149989A89972CE889DF8B",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "TRACEABLE"
                        },
                        "alternative_code": "S",
                        "description": null,
                        "id": "4F656ED5DAC44168B0805227881202CD"
                    },
                    "alternative_code": "lp-indirectsales-smart006",
                    "serial_number": "lp-indirectsales-smart006",
                    "id": "C399295063AC4F4CA3F5E89F08EEFB8E",
                    "state": "EFFECTIVE"
                },
                "performed_date": "2016-06-30T07:02:55",
                "performed_by":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "sales_method": "INDIRECT_SALE",
                "id": "B164A59960854BE89097D9BA8AB6E3BD",
                "invoice": null,
                "stock_out_warehouse_transaction":
                {
                    "number": "701",
                    "batch_number": null,
                    "id": "B1167F6DE17A4F94978A0F9241C8914A",
                    "life_cycle_state": "POSTED"
                }
            }
        ],
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    } 

Related pages