Versions Compared

Old Version 103

changes.mady.by.user Ekaterini Tzirtzipi

Saved on

compared with

New Version 104

changes.mady.by.user Ekaterini Tzirtzipi

Saved on

Key

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

Available from CRM.COM R3.0.0

 

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

job_identifier

(mandatory)

Job identifier  

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

Include Page
V4:job_identifier
V4:job_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable identifier

The identifier of the account related with the job that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(semi-optional)

Job type identifier

The identifier of the job type related with the jobs that should be returned as a result. The allowed job type identifier fields are the following:

Include Page
V4:job_type_identifier
V4:job_type_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

period
(mandatory)

NumberThe length of time for which an activity is close to estimated completion

uot
(mandatory)

StringThe unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

accounts_receivable_identifier

(optional)

Accounts receivable identifier 

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Job type identifier

The identifier of the type of the retrieved job. The allowed job type identifier fields are the following:

Include Page
V4:job_type_identifier
V4:job_type_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier 

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Job type identifier

The identifier of the type of the retrieved job. The allowed job type identifier fields are the following:

Include Page
V4:job_type_identifier
V4:job_type_identifier

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

...

This method returns information related with jobs that are draft

Tip

Available from CRM.COM R6.0.0


Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier 

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Job type identifier

The identifier of the type of the retrieved job. The allowed job type identifier fields are the following:

Include Page
V4:job_type_identifier
V4:job_type_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier 

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Job type identifier

The identifier of the type of the retrieved job. The allowed job type identifier fields are the following:

Include Page
V4:job_type_identifier
V4:job_type_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier 

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Job type identifier

The identifier of the type of the retrieved job. The allowed job type identifier fields are the following:

Include Page
V4:job_type_identifier
V4:job_type_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier 

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Job type identifier

The identifier of the type of the retrieved job. The allowed job type identifier fields are the following:

Include Page
V4:job_type_identifier
V4:job_type_identifier

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

...

This method returns information related with jobs that are cancelled

Tip

Available from CRM.COM R6.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts receivable identifier 

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Job type identifier

The identifier of the type of the retrieved job. The allowed job type identifier fields are the following:

Include Page
V4:job_type_identifier
V4:job_type_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier
(mandatory)

Job type identifier

The identifier of the type of the new job. The allowed job type identifier fields are the following:

Include Page
V4:job_type_identifier
V4:job_type_identifier

status_identifier
(optional)

Job status identifier

The identifier of the status of the new job. If not specified then the default one will be used. The allowed job status identifier fields are the following:

Include Page
V4:job_status_identifier
V4:job_status_identifier

category_identifier
(mandatory)

Job category identifier

The identifier of the category of the new job. The allowed job category identifier fields are the following:

Include Page
V4:job_category_identifier
V4:job_category_identifier

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier

The identifier of the new job accounts receivable. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

subscription_identifier

(mandatory on conditions)

Subscriptions Identifier

The identifier of the subscription that will be maintained through the new job. This information is applicable and mandatory only if the specified job type has fulfillment scope equal to ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION, SWAP_SUBSCRIPTION_INSTALLED_ITEMS, SWAP_SUBSCRIPTION_SERVICES. The allowed subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

Tip

Available from CRM.COM R8.0.0

Tip

Job Types with fulfillment scope SWAP_SUBSCRIPTION_INSTALLED_ITEMS and SWAP_SUBSCRIPTION_SERVICES are available from CRM.COM R9.0.0

contact_email

(optional)

String

The email of the customer related with the job, which will be used in order to communicate the job

Tip

Available from CRM.COM R6.0.0


contact_phone

(optional)

 String

 The phone of the customer related with the job, which will be used in order to communicate the job

Tip

Available from CRM.COM R6.0.0


description
(optional)

StringThe description of the new job

notes
(optional)

StringThe notes of the new job

start_date
(optional)

DateThe date that the job is created

location_identifier
(mandatory)

Job location identifier

The identifier of the location of the new job. The allowed job location identifier fields are the following:

Include Page
V4:address_identifier
V4:address_identifier

owned_by_group_identifier
(optional)

The identifier of the owned by group information

The owned by group information of the job. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

privacy_level_identifier
(optional)

The identifier of the privacy level

The privacy level of the job. The allowed privacy level identifier fields are the following:

Include Page
V4:privacy_level_identifier
V4:privacy_level_identifier

service_request_identifier
(optional)		The identifier of the service request

The service request related with the job. The allowed service request identifier fields are the following:

Include Page
V4:service_request_identifier
V4:service_request_identifier

Tip

Available from CRM.COM R7.0.0

udf_string_1 

(optional)

String

User Defined Field of type String

udf_string_2 

(optional)

String

User Defined Field of type String

udf_string_3 

(optional)

String

User Defined Field of type String

udf_string_4 

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6 

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1 

(optional)

Date

User Defined Field of type Date

udf_date_2 

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

expected_completion_date
(semi-optional)

DateThe date that the job is expected to be completed. It is automatically calculated if estimate completion time is specified.

estimated_completion_time
(semi-optional)

Time Period ObjectThe time that is estimated to complete the job, measured in minutes, hours, days, weeks, years. It is automatically calculated if expected completion date is specified.
billing_terms
(mandatory on conditions)		Job Billing terms object

The billing terms of the job to be created. This information is applicable and mandatory if the job type fulfillment method is set to Generic Purpose

Tip

For Releases previous to CRM.COM R6.0.0 this information is mandatory only if the job is billable


requested_subscription_billing_terms

(optional)

Subscription Billing terms object

The billing terms of the subscription that will be provided as part of the job. This information is applicable and mandatory if the job type fulfillment method is set to New Subscription

Tip

Available from CRM.COM R6.0.0


assigned_to
(optional)		Assigned to objectThe assignment information for the job
physical_goods_to_be_provided_set
(optional)		Set of physical good to be provided objects

The physical goods that will be provided as part of the job

Tip

This information will be deprecated in CRM.COM R6.0.0

expenses_set
(optional)		Set of expense objects

A list of one time services which are applied on the job as expenses

Tip

This information will be deprecated in CRM.COM R6.0.0

activities_set
(optional)		Set of activity objects

A set of activities which are planned for the specific job

Tip

This information will be deprecated in CRM.COM R6.0.0

requested_subscription_services_set

(mandatory on conditions)

Set of Requested Subscription Service Objects

A list of services that were requested by the customer and should be provided as part of the subscription that will be delivered. This information is applicable and mandatory only if the job type fulfillment method is set to New Subscription, Add Subscription Services of Swap Subscription Services. The subscription services are filtered based on the specified subscription type and billing term scheme. All the subscription related rules and restrictions are applicable on the requested subscription services as well

Tip

Available from CRM.COM R6.0.0

Tip

Information is available for Swap Subscription Services too from CRM.COM R9.0.0

requested_physical_goods_set

(mandatory on conditions)

Set of Requested Physical Good Objects

A list of physical goods (products only) that are requested by the customer, and should be delivered as part of fulfilling the ordered job. The requested physical goods are filtered based on the selected job type. Mandatory physical goods are added automatically.

Tip

Available from CRM.COM R6.0.0

requested_subscription_physical_goods_set

(mandatory on conditions)

Set of Requested Subscription Physical Good Objects

A list of physical goods (products only) that were requested by the customer and should be provided as part of the subscription that will be delivered. This information is applicable and mandatory only if the job type fulfillment method is set to New Subscription, Add Subscription Services and Swap Subscription Installed Items. The subscription physical goods are filtered based on the specified subscription type. All the subscription related rules and restrictions are applicable on the requested subscription physical goods as well

Tip

Available from CRM.COM R6.0.0

Tip

Information is also available for Swap Subscription Installed Item jobs from CRM.COM R9.0.0

requested_expenses_set

(mandatory on conditions)

Set of Requested Expense Objects

A list of requested expenses that are requested by the customer and should be delivered as part of fulfilling the ordered job. The requested expenses are filtered based on the selected job type. Mandatory expenses are added automatically

Tip

Available from CRM.COM R6.0.0

requested_activity_services_set

(mandatory on conditions)

Set of Requested Activity Service Objects

A list of one time services that are requested by the customer and should be delivered by a scheduling and performing a specific activity. The requested activity services are defined by specifying the type of the activity and the activity services that should be performed. The activity types are filtered based on the selected job type. The activity services are filtered based on the selected activity type. Mandatory activity types and services are added automatically.

Tip

Available from CRM.COM R6.0.0

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

Tip

Available from CRM.COM R10.0.0

Anchor
job_create referred objects parameters
job_create referred objects parameters
Referred Parameter Objects Data

...

Name

Type

Description

token

String

The token retrieved from the login method

job_identifier
(mandatory)		Job identifier

The identifier of the job. The allowed job identifier fields are the following:

Include Page
V4:job_identifier
V4:job_identifier

status_identifier
(optional)

Job status identifier

The identifier of the status of the new job. The allowed job status identifier fields are the following:

Include Page
V4:job_status_identifier
V4:job_status_identifier

category_identifier
(optional)

Job category identifier

The identifier of the category of the new job. The allowed job category identifier fields are the following:

Include Page
V4:job_category_identifier
V4:job_category_identifier

description
(optional)		StringThe description of the new job

notes
(optional)

StringThe notes of the new job

contact_email

(optional)

String

The email of the customer related with the job, which will be used in order to communicate the job

 

Tip

Available from CRM.COM R6.0.0

contact_phone

(optional)

String

 The phone of the customer related with the job, which will be used in order to communicate the job

 

Tip

Available from CRM.COM R6.0.0

start_date
(optional)

DateThe date that the activity is created

location_identifier
(optional)

Job location identifier

The identifier of the location of the new job. The allowed job location identifier fields are the following:

Include Page
V4:address_identifier
V4:address_identifier

owned_by_group_identifier
(optional)

The identifier of the owned by group information

The owned by group information of the job. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

privacy_level_identifier
(optional)

The identifier of the privacy level

The privacy level of the job. The allowed privacy level identifier fields are the following:

Include Page
V4:privacy_level_identifier
V4:privacy_level_identifier

udf_string_1
(optional)

String

User Defined Field of type String

udf_string_2
(optional)

String

User Defined Field of type String

udf_string_3
(optional)

String

User Defined Field of type String

udf_string_4
(optional)

String

User Defined Field of type String

udf_string_5
(optional)

String

User Defined Field of type String

udf_string_6
(optional)

String

User Defined Field of type String

udf_string_7
(optional)

String

User Defined Field of type String

udf_string_8
(optional)

String

User Defined Field of type String

udf_float_1
(optional)

Float

User Defined Field of type Float

udf_float_2
(optional)

Float

User Defined Field of type Float

udf_float_3
(optional)

Float

User Defined Field of type Float

udf_float_4
(optional)

Float

User Defined Field of type Float

udf_date_1
(optional)

Date

User Defined Field of type Date

udf_date_2
(optional)

Date

User Defined Field of type Date

udf_date_3
(optional)

Date

User Defined Field of type Date

udf_date_4
(optional)

Date

User Defined Field of type Date

expected_completion_date
(optional)

DateThe date that the job is expected to be completed. It is automatically calculated if estimate completion time is specified.

estimated_completion_time
(optional)

Time Period ObjectThe time that is estimated to complete the job, measured in minutes, hours, days, weeks, years. It is automatically calculated if expected_completion_time is specified.
billing_terms
(optional)		Billing terms object

The billing terms of the retrieved job.This information is applicable if the job type fulfillment method is set to Generic Purpose and if the job is still draft or pending

Tip

For Releases previous to CRM.COM R6.0.0 this information is applicable for any type of billable jobs

requested_subscription_billing_terms

(optional)

Subscription Billing terms object

The billing terms of the subscription that will be provided as part of the job. This information is applicable if the job type fulfillment method is set to New Subscription and if the job is still draft or pending

Tip

Available from CRM.COM R6.0.0


assigned_to
(optional)		Assigned to objectThe assignment information for the retrieved job. Assign to information is mandatory to be specified, unless if it is set automatically through ACR rules.

requested_subscription_services_set

(optional)

Set of Requested Subscription Service Objects

The requested subscription services. This information is applicable only if the job type fulfillment scope is set to New Subscription, Add Subscription Services or Swap Subscription Services and if the job is draft or pending

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

Tip

Available from CRM.COM R6.0.0

Tip

The information is also available for Swap Subscription Service jobs from CRM.COM R9.0.0

requested_physical_goods_set

(optional)

Set of Requested Physical Good Objects

The requested physical goods. This information is applicable only if the job is draft or pending

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

Tip

Available from CRM.COM R6.0.0


requested_subscription_physical_goods_set

(optional)

Set of Requested Subscription Physical Good Objects

The requested subscription physical goods. This information is applicable only if the job type fulfillment scope is set to New Subscription or Add Subscription Services or Swap Subscription Installed Items and if the job is draft or pending

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

Tip

Available from CRM.COM R6.0.0

Tip

The information is also available for Swap Subscription Installed Item jobs from CRM.COM R9.0.0


requested_expenses_set

(optional)

Set of Requested Expense Objects

The requested expenses. This information is applicable only if the job is draft or pending

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

Tip

Available from CRM.COM R6.0.0


requested_activity_services_set

(optional)

Set of Requested Activity Service Objects

The requested activity services. This information is applicable only if the job is draft or pending

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

Tip

Available from CRM.COM R6.0.0


physical_goods_set
(optional)		Set of physical good to be provided objects

The physical goods that will be provided as part of the retrieved job. This information is applicable only if the job is in progress

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

Tip

In releases previous to CRM.COM R6.0.0, physical_goods_set is available as physical_goods_to_be_provided_set. This object is deprecated in CRM.COM R6.0.0

expenses_set
(optional)		Set of expense objects

A list of one time services which are applied on the retrieved job as expenses. This information is applicable only if the job is in progress

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

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

Tip

Available from CRM.COM R10.0.0

Anchor
job_update referred objects parameters
job_update referred objects parameters
Referred Parameter Objects Data

...

Expand
titleExample 3

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token":"3EEEA4A93F304D4AA81AB394507EDE82",
    "job_identifier": { "number" : "JOB000477" },
    "requested_subscription_physical_goods_set":
    [
       {
        "action":"add",
        "installed_item_identifier":{"serial_number":"SM0005"}
        },
        {
        "action":"remove",
        "job_requested_subscription_physical_good_identifier":{"id":"4E5A414F50E843659F9C05A3A170A709"}
        },
     ]
}

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

    {
        "status":
        {
            "message": "",
            "description": "",
            "code": "OK"
        },
        "data":
        {
            "requested_physical_goods_set":
            [
            ],
            "service_request": null,
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "udf_string_1": null,
            "udf_string_2": null,
            "assigned_to":
            {
                "unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "udf_string_3": null,
            "privacy_level": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "contact_phone": null,
            "activities_set":
            [
            ],
            "udf_string_6": null,
            "udf_string_7": null,
            "physical_goods_set":
            [
            ],
            "udf_string_8": null,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Papapavlou",
                    "middle_name": null,
                    "life_cycle_state": "FINANCIAL",
                    "company_profile": null,
                    "title": "Miss",
                    "first_name": "Loukia",
                    "type": "PERSON",
                    "id": "37072CF6ED884737B6592A7CBB6D5342",
                    "name": "Papapavlou Loukia",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "FEMALE",
                        "passport_issued_by_country": null,
                        "social_security_number": null,
                        "passport_number": null,
                        "industry_sector": null,
                        "country_of_residence":
                        {
                            "three_character_code": "CYP",
                            "two_character_code": "CY",
                            "id": "181",
                            "name": "CYPRUS",
                            "alternative_code": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "id_number": "LP1234",
                        "industry": null,
                        "id_issued_by_country": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "ACR000852",
                "id": "A86D415E729945C6933177D83319FBE6",
                "name": "ACR000852"
            },
            "id": "9A87BFB77BF44CEF8C8F675926DD7EAE",
            "requested_activity_services_set":
            [
            ],
            "requested_subscription_physical_goods_set":
            [
                {
                    "swap_installed_item": null,
                    "provisioning_distributor": null,
                    "installed_item":
                    {
                        "state": "EFFECTIVE",
                        "serial_number": "SM0005",
                        "id": "BA0371AEB0AC4A259804014CBB657B94",
                        "alternative_code": "SM0005",
                        "product":
                        {
                            "product_type":
                            {
                                "service_type": null,
                                "physical_good_type": "TRACEABLE",
                                "used_for_provisioning": false,
                                "classification": "PHYSICALGOODS",
                                "composition_method": "FLAT",
                                "id": "6173FC99331504AD1ACB5D697D54DA8C",
                                "name": "Smartcards",
                                "description": "Smartcards",
                                "alternative_code": "SC"
                            },
                            "id": "EAC7A30429364176616CFEF5DF709941",
                            "description": "Smartcard 1",
                            "code": "Smartcard 1",
                            "alternative_code": "SC1"
                        }
                    },
                    "id": "A165742689E84C82B2DA42553564D74F",
                    "quantity": 1,
                    "product":
                    {
                        "product_type":
                        {
                            "service_type": null,
                            "physical_good_type": "TRACEABLE",
                            "used_for_provisioning": false,
                            "classification": "PHYSICALGOODS",
                            "composition_method": "FLAT",
                            "id": "6173FC99331504AD1ACB5D697D54DA8C",
                            "name": "Smartcards",
                            "description": "Smartcards",
                            "alternative_code": "SC"
                        },
                        "id": "EAC7A30429364176616CFEF5DF709941",
                        "description": "Smartcard 1",
                        "code": "Smartcard 1",
                        "alternative_code": "SC1"
                    }
                }
            ],
            "expected_completion_date": "2016-02-29T12:13:16",
            "time_to_completion":
            {
                "time_period_value": 5,
                "time_period_uot": "DAYS"
            },
            "time_overdue":
            {
                "time_period_value": null,
                "time_period_uot": null
            },
            "log_information":
            {
                "updated_date": "2016-02-24T12:40:33",
                "created_date": "2016-02-24T12:13:16",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "life_cycle_state": "PENDING",
            "location":
            {
                "udf_string_10": null,
                "street_number": "4",
                "care_of": null,
                "udf_string_11": null,
                "udf_float_1": null,
                "street_name": "Markou Drakou",
                "udf_string_12": null,
                "udf_float_2": null,
                "udf_string_13": null,
                "udf_float_3": null,
                "udf_string_14": null,
                "udf_float_4": null,
                "udf_string_15": null,
                "udf_string_16": null,
                "po_box": null,
                "udf_string_1": null,
                "floor": null,
                "udf_string_2": null,
                "area": null,
                "udf_string_3": null,
                "district": null,
                "udf_string_4": null,
                "udf_string_5": null,
                "udf_string_6": null,
                "udf_string_7": null,
                "state": "Active",
                "udf_string_8": null,
                "udf_string_9": null,
                "country":
                {
                    "three_character_code": "CYP",
                    "two_character_code": "CY",
                    "id": "181",
                    "name": "CYPRUS",
                    "alternative_code": null
                },
                "id": "2F132D5A059846EF8288B8A9AAC37E00",
                "postal_code": "2213",
                "udf_date_1": null,
                "udf_date_2": null,
                "udf_date_3": null,
                "udf_date_4": null,
                "po_box_postal_code": null,
                "apartment_number": null,
                "town_city": null,
                "type": "Home",
                "municipality": null
            },
            "type":
            {
                "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
                "fulfillment_scope": "SWAP_SUB_INSTALLED_ITEMS",
                "id": "6D1937BD1F1846CDA6AE994FD4C8B46F",
                "name": "Swap Sub Installed Item LP",
                "description": null,
                "alternative_code": "Swap Sub Installed Item LP"
            },
            "contact_email": null,
            "expenses_set":
            [
            ],
            "notes": null,
            "billing_terms":
            {
                "binding_information": null,
                "agreement_date": "2016-02-24T00:00:00",
                "concurrent_usage_based_pricing":
                {
                    "concurrent_usage": 1,
                    "rate_percentage": 100
                },
                "billing_term_scheme":
                {
                    "life_cycle_state": "EFFECTIVE",
                    "billing_method": "PERIOD",
                    "classification": "JOBS",
                    "id": "1B708E843AF1497595A4EE39A1F62ED0",
                    "name": "Jobs Scheme - Concurrent",
                    "code": "Jobs Scheme - Concurrent",
                    "billing_type": "NORMAL"
                },
                "effective_date": "2016-02-24T00:00:00",
                "billing_frequency": null,
                "id": "8DEE60C3256642E9BD7A00DD0C218D91",
                "allowed_cancel_date": null,
                "expiration_date": null,
                "billing_cycle_day": null,
                "price_plan":
                {
                    "effective_date": "2015-12-20T00:00:00",
                    "type": "BASE",
                    "id": "5AA9D4219DA549048AB263635CA6AD09",
                    "name": "BPP0614",
                    "description": "Base Price PLan June 14 for Subscription Test Case 6",
                    "code": "BPP0614",
                    "expiration_date": null
                }
            },
            "number": "JOB000477",
            "estimated_completion_time":
            {
                "time_period_value": 5,
                "time_period_uot": "DAYS"
            },
            "requested_subscription":
            {
                "life_cycle_state": "EFFECTIVE",
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Papapavlou",
                        "middle_name": null,
                        "life_cycle_state": "FINANCIAL",
                        "company_profile": null,
                        "title": "Miss",
                        "first_name": "Loukia",
                        "type": "PERSON",
                        "id": "37072CF6ED884737B6592A7CBB6D5342",
                        "name": "Papapavlou Loukia",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": "FEMALE",
                            "passport_issued_by_country": null,
                            "social_security_number": null,
                            "passport_number": null,
                            "industry_sector": null,
                            "country_of_residence":
                            {
                                "three_character_code": "CYP",
                                "two_character_code": "CY",
                                "id": "181",
                                "name": "CYPRUS",
                                "alternative_code": null
                            },
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "id_number": "LP1234",
                            "industry": null,
                            "id_issued_by_country": null
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "ACR000852",
                    "id": "A86D415E729945C6933177D83319FBE6",
                    "name": "ACR000852"
                },
                "number": "S60692",
                "type":
                {
                    "udf_float_1": null,
                    "udf_float_2": null,
                    "udf_date_1": null,
                    "udf_float_3": null,
                    "udf_date_2": null,
                    "udf_float_4": null,
                    "udf_date_3": null,
                    "udf_date_4": null,
                    "name": "United Kingdom",
                    "udf_string_1": null,
                    "udf_string_2": null,
                    "udf_string_3": null,
                    "udf_string_4": null,
                    "udf_string_5": null,
                    "udf_string_6": null,
                    "udf_string_7": null,
                    "log_information":
                    {
                        "updated_date": "2016-01-30T09:57:23",
                        "created_date": "2014-06-25T15:44:04",
                        "created_by_unit":
                        {
                            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                            "name": "Admin Unit",
                            "group_name": "Main Group",
                            "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                            "alternative_code": "MG"
                        },
                        "updated_by_unit":
                        {
                            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                            "name": "Admin Unit",
                            "group_name": "Main Group",
                            "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                            "alternative_code": "MG"
                        },
                        "updated_by_user":
                        {
                            "person_name": "MPAdministrator",
                            "username": "MPAdministrator",
                            "id": "1"
                        }
                    },
                    "udf_string_8": null,
                    "id": "1C81FBB1E5D90040F440ECE98D6A368D",
                    "description": "United Kingdom",
                    "alternative_code": "UK"
                },
                "id": "4ADBEF42548B4EF9B860B749E96C8E87"
            },
            "subscription_services_set":
            [
                {
                    "life_cycle_state": "EFFECTIVE",
                    "id": "C28C7352EBDF4B42A33B63038BF35C9A",
                    "service_bundle": null,
                    "product":
                    {
                        "product_type":
                        {
                            "service_type": "TERMED",
                            "physical_good_type": null,
                            "used_for_provisioning": true,
                            "classification": "SERVICES",
                            "composition_method": "FLAT",
                            "id": "BC954969D3172372D498D3BB2BA590A0",
                            "name": "Subscription Packages",
                            "description": "Subscription main packages",
                            "alternative_code": "SP"
                        },
                        "id": "6DF884D00A643D9E5E3E95A5ABCCFDF8",
                        "description": "Gold Premium Package",
                        "code": "Gold",
                        "alternative_code": "GPP"
                    }
                }
            ],
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "start_date": "2016-02-24T12:13:16",
            "udf_date_4": null,
            "bills_set":
            [
            ],
            "requested_expenses_set":
            [
            ],
            "owned_by_group":
            {
                "community_name": "Internal Community",
                "id": "84F33366CB592BAAE7E2044D93611C6A",
                "name": "Main Group",
                "description": "Main Group",
                "alternative_code": "MG1"
            },
            "status":
            {
                "life_cycle_state": "PENDING",
                "id": "JobStatus1",
                "name": "Assigned",
                "description": null,
                "alternative_code": "AS"
            },
            "actual_completed_date": null,
            "subscription_physical_goods_set":
            [
                {
                    "ownership_status": null,
                    "installed_item":
                    {
                        "state": "EFFECTIVE",
                        "serial_number": "sb20001118",
                        "id": "BC4D9573AFD04E2EA59174AA7BE038FE",
                        "alternative_code": "sb20001118",
                        "product":
                        {
                            "product_type":
                            {
                                "service_type": null,
                                "physical_good_type": "TRACEABLE",
                                "used_for_provisioning": true,
                                "classification": "PHYSICALGOODS",
                                "composition_method": "FLAT",
                                "id": "B4A1396AE3D1384B304A0FEB22F7BA50",
                                "name": "Decoders",
                                "description": "Decoders",
                                "alternative_code": "D"
                            },
                            "id": "12A61F321368703D77C48A0A085D9B7D",
                            "description": "Decoders 2",
                            "code": "Decoders 2",
                            "alternative_code": "D2"
                        }
                    },
                    "installed_item_bundle": null,
                    "id": "067B8687070F40A39780E737270CA9F3"
                },
                {
                    "ownership_status": "RENTED_TO_CUSTOMER",
                    "installed_item":
                    {
                        "state": "EFFECTIVE",
                        "serial_number": "SM0005",
                        "id": "BA0371AEB0AC4A259804014CBB657B94",
                        "alternative_code": "SM0005",
                        "product":
                        {
                            "product_type":
                            {
                                "service_type": null,
                                "physical_good_type": "TRACEABLE",
                                "used_for_provisioning": false,
                                "classification": "PHYSICALGOODS",
                                "composition_method": "FLAT",
                                "id": "6173FC99331504AD1ACB5D697D54DA8C",
                                "name": "Smartcards",
                                "description": "Smartcards",
                                "alternative_code": "SC"
                            },
                            "id": "EAC7A30429364176616CFEF5DF709941",
                            "description": "Smartcard 1",
                            "code": "Smartcard 1",
                            "alternative_code": "SC1"
                        }
                    },
                    "installed_item_bundle": null,
                    "id": "7832753D414A4C13BD823C7B7EC2CFF9"
                }
            ],
            "description": null,
            "category": null
        }
    }
Expand
titleExample 4

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token":"C943ADCFB435444B85D8E605C79EB989",
    "job_identifier"         :    { "number" : "JOB000576" },
    "fields_set":"requested_expenses_set,estimated_completion_time,billing_terms,requested_activity_services_set",
    "requested_subscription_services_set":
    [
        {
        "action":"add",
        "service_identifier":{"code":"Cartoons 1"},
        "provisioning_distribution_set":[
                {
                    "provisioning_distributor_identifier":{
                        "name":"Main"
                    }
                },
                {
                    "provisioning_distributor_identifier":{
                        "name":"Twin 1"
                    }
                }
        ]
        },
        {
        "action":"add",
        "service_identifier":{"code":"Cartoons 2"},
        "provisioning_distribution_set":[
                {
                    "provisioning_distributor_identifier":{
                        "name":"Main"
                    }
                },
                {
                    "provisioning_distributor_identifier":{
                        "name":"Twin 1"
                    }
                }
        ]
        },
        {
        "action":"add",
        "service_identifier":{"code":"Platinum - Flex"},
                "provisioning_distribution_set":[
                {
                    "provisioning_distributor_identifier":{
                        "name":"Main"
                    }
                },
                {
                    "provisioning_distributor_identifier":{
                        "name":"Twin 1"
                    }
                }
        ],
        "components_set":[
                {
                    "service_identifier":{"code":"Cartoons 1 "}
                }
        ]
        }
    ],
    "requested_subscription_physical_goods_set":
    [
        {
        "action":"add",
        "product_identifier":{"code":"Decoders 1"},
                "quantity":2,
                "provisioning_distribution_set":[
                {
                    "provisioning_distributor_identifier":{
                        "name":"Main"
                    }
                },
                {
                    "provisioning_distributor_identifier":{
                        "name":"Twin 1"
                    }
                }
        ]
        },
        {
        "action":"add",
        "product_identifier":{"code":"Smartcard 1"},
                "quantity":4
        }
    ],
    "requested_expenses_set":
    [
        {
        "action":"add",
        "product_identifier":{"code":"Expence 2"}
        }
    ],
    
    "requested_activity_services_set":
    [
        {
        "action":"add",
        "activity_type_identifier":{"name":"InstallationsX"},
        "product_identifier":{"code":"Material Delivery"}
        }
    ]
}

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 
 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "requested_activity_services_set": [
      {
        "activity_type": {
          "id": "938B9B6411AAB03DC25B3F569A443C6D",
          "name": "InstallationsX",
          "description": "Test",
          "alternative_code": "INX"
        },
        "id": "BC672A1426784175B217BBAE06AD4739",
        "product": {
          "id": "8F7A45F44BBEB320718F309F58CCE097",
          "description": "Installation",
          "code": "Installation Fee",
          "alternative_code": "Ins"
        }
      },
      {
        "activity_type": {
          "id": "938B9B6411AAB03DC25B3F569A443C6D",
          "name": "InstallationsX",
          "description": "Test",
          "alternative_code": "INX"
        },
        "id": "803280E1851F4CA4A72BB583C0ABC87E",
        "product": {
          "id": "362AF22847BA4ED0CDED5CDFF8BABBC1",
          "description": "Delivery of Materials Service Charge",
          "code": "Material Delivery",
          "alternative_code": "MD"
        }
      },
      {
        "activity_type": {
          "id": "B163FF3F08B44CBEB00F1CCD875C54DE",
          "name": "Installation",
          "description": null,
          "alternative_code": "INS"
        },
        "id": "F8F2F2505C864AB5BF3D9241ADFDA05E",
        "product": {
          "id": "690A6B1932D34421A1EE254425F2CB12",
          "description": null,
          "code": "Installation Service",
          "alternative_code": "IS"
        }
      }
    ],
    "billing_terms": {
      "binding_information": null,
      "agreement_date": "2016-06-09T00:00:00",
      "concurrent_usage_based_pricing": {
        "concurrent_usage": 1,
        "rate_percentage": 100
      },
      "billing_term_scheme": {
        "life_cycle_state": "EFFECTIVE",
        "billing_method": "PERIOD",
        "classification": "JOBS",
        "id": "1B708E843AF1497595A4EE39A1F62ED0",
        "name": "Jobs Scheme - Concurrent",
        "code": "Jobs Scheme - Concurrent",
        "billing_type": "NORMAL"
      },
      "effective_date": "2016-06-09T00:00:00",
      "billing_frequency": null,
      "id": "E9F146155FEB41268DB33166E8EB7745",
      "allowed_cancel_date": null,
      "expiration_date": null,
      "billing_cycle_day": null,
      "price_plan": {
        "effective_date": "2016-04-08T00:00:00",
        "type": "BASE",
        "id": "62F4D4E787AD4ACC895FD1D066037353",
        "name": "BPP0614",
        "description": "Base Price PLan June 14 for Subscription Test Case 6",
        "code": "BPP0614",
        "expiration_date": null
      }
    },
    "estimated_completion_time": {
      "time_period_value": 9.166666666666666,
      "time_period_uot": "MONTHS"
    },
    "requested_expenses_set": [
      {
        "id": "890D885F5F0A475696826AD21CA1F0C8",
        "product": {
          "product_type": {
            "service_type": "EXPENSE",
            "physical_good_type": null,
            "used_for_provisioning": false,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "67FA013211E348C58F7CD27F8399AADE",
            "name": "Expense Type",
            "description": null,
            "alternative_code": "ET"
          },
          "id": "2855ACFCB7D94ED69A5FC3B9557EB6D6",
          "description": "Expence 1",
          "code": "Expence 1",
          "alternative_code": "exp1"
        }
      },
      {
        "id": "F258B6294A3F48E391C22165F8F6EBC3",
        "product": {
          "product_type": {
            "service_type": "EXPENSE",
            "physical_good_type": null,
            "used_for_provisioning": false,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "67FA013211E348C58F7CD27F8399AADE",
            "name": "Expense Type",
            "description": null,
            "alternative_code": "ET"
          },
          "id": "81D5550CF6004CE0B206A371F9F3A18A",
          "description": "Expence 2",
          "code": "Expence 2",
          "alternative_code": "exp2"
        }
      }
    ]
  }
}

POST jobs/bill

It bills one job based on a specific as of date

...

Name

Type

Description

token

String

The token retrieved from the login method

job_identifier

(mandatory)

Job identifier  

The identifier of the job that should be billed. The allowed jobs identifier fields are the following:

Include Page
V4:job_identifier
V4:job_identifier

as_of_date
(mandatory)

DateThe date that will be used to bill the job

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

...

Name

Type

Description

token

String

The token retrieved from the login method

job_identifier

(mandatory)

Job identifier  

The identifier of the job that should be previewed. The allowed jobs identifier fields are the following:

Include Page
V4:job_identifier
V4:job_identifier

as_of_date
(mandatory)

DateThe date that will be used to bill the job

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

...

This method cancels a job, which is not already completed or cancelled.  

Tip

Available from CRM.COM R6.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

job_identifier

(mandatory)

JobIdentifier

The identifier of the job to be cancelled. The allowed job identifier fields are the following:

Include Page
V4:job_identifier
V4:job_identifier

status_identifier

(optional)

Job Status Identifier

The status that will be set on the job, after the cancellation. If not specified the the default status for cancelling jobs of that type will be used. The allowed job status identifiers are the following:

Include Page
V4:job_status_identifier
V4:job_status_identifier

cancellation_reason_identifier

(mandatory)

Job Cancellation Reason Identifier

The reason for cancelling the job. The allowed job cancellation reason identifiers are the following:

Include Page
V4:job_cancellation_reason_identifier
V4:job_cancellation_reason_identifier

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

Tip

Available from CRM.COM R10.0.0

Restrictions

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

...

This method sets a job in progress. This method can be applied only on pending jobs

Tip

Available from CRM.COM R6.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

job_identifier

(mandatory)

JobIdentifier

The identifier of the job that will be started. The allowed job identifier fields are the following:

Include Page
V4:job_identifier
V4:job_identifier

status_identifier

(optional)

Job Status Identifier

The status that will be set on the job, after starting the progress. If not specified the the default status for starting jobs of that type will be used. The allowed job status identifiers are the following:

Include Page
V4:job_status_identifier
V4:job_status_identifier

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

Tip

Available from CRM.COM R10.0.0

 

Restrictions

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

...

This method completes a job, which is already in progress

Tip

Available from CRM.COM R6.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

job_identifier

(mandatory)

JobIdentifier

The identifier of the job that will be completed. The allowed job identifier fields are the following:

Include Page
V4:job_identifier
V4:job_identifier

status_identifier

(optional)

Job Status Identifier

The status that will be set on completing the job. If not specified the the default status for completing jobs of that type will be used. The allowed job status identifiers are the following:

Include Page
V4:job_status_identifier
V4:job_status_identifier

performed_by_user_identifier

(optional)

User identifier

 The user that actually performed the action. This information is applicable only if the job type fulfillment scope is set to New Subscription. The allowed user identifier fields are the following:

Include Page
V4:user_identifier
V4:user_identifier

performed_on

(optional)

Date The date that the action was actually performed. This information is applicable only if the job type fulfillment scope is set to New Subscription.

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

Tip

Available from CRM.COM R10.0.0

Restrictions

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

...