Tip
Available from CRM.COM R11.0.0

Table of Contents

maxLevel	2

...

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

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

{
        "data":
        {
            "notes": null,
            "contact_phone": null,
            "log_information":
            {
                "created_by_unit":
                {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "updated_by_unit":
                {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2016-08-24T09:39:51",
                "updated_date": "2016-08-24T09:40:12",
                "updated_by_user":
                {
                    "person_name": "CRM COM",
                    "id": "1",
                    "username": "MPAdministrator"
                },
                "created_by_user":
                {
                    "person_name": "CRM COM",
                    "id": "1",
                    "username": "MPAdministrator"
                }
            },
            "requested_physical_goods_set":
            [
            ],
            "type":
            {
                "alternative_code": "RPG",
                "name": "Replace Physical Goods",
                "fulfillment_scope": "REPLACE_PHYSICAL_GOODS",
                "description": null,
                "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
                "id": "E859291E838947F58C09BD0799E3613D"
            },
            "number": "J00000418",
            "id": "B26FC357BDFD46349EB4F136235A2204",
            "actual_completed_date": null,
            "requested_expenses_set":
            [
            ],
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "privacy_level": null,
            "udf_string_1": null,
            "life_cycle_state": "DRAFT",
            "activities_set":
            [
            ],
            "physical_goods_set":
            [
            ],
            "time_overdue":
            {
                "time_period_uot": null,
                "time_period_value": null
            },
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "status":
            {
                "alternative_code": "IP",
                "name": "Draft",
                "description": null,
                "id": "C9AFA1C35F628CB2B279C98D4CA45C5E",
                "life_cycle_state": "DRAFT"

POST jobs/replace_physical_goods/create

This method creates a job of fulfillment scope Replace Physical Goods. Single job can be created by each call. Only customer jobs can be created through this method.

Resource URL

Parameters

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
(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

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

contact_email

(optional)

String

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

contact_phone

(optional)

String

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

description
(optional)

String

The description of the new job

notes
(optional)

String

The notes of the new job

start_date
(optional)

Date

The date that the job is created

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

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)

Date

The 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 Object

The 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 only if the job is billable

assigned_to
(mandatory)

Assigned to object

The assignment information for the job

requested_replaced_physical_goods_set

(mandatory)

Set of Requested Physical Goods to be replaced Objects

The requested physical goods (installed items) that will be replaced as part of fulfilling this job. The traceable physical goods are filtered based on the traceable physical goods which are owned by the account owner and are not used in any subscriptions

requested_physical_goods_set

(optional)

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.

requested_expenses_set

(optional)

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

requested_activity_services_set

(optional)

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.

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

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

Include Page

	V4:time_period_parameters
	V4:time_period_parameters

Include Page

	V4:r10_billing_terms_jobs_parameters
	V4:r10_billing_terms_jobs_parameters

Include Page

	V4:assigned_to_parameters
	V4:assigned_to_parameters

Include Page

	V4:job_requested_physical_goods_replacements_parameters
	V4:job_requested_physical_goods_replacements_parameters

Include Page

	V4:job_requested_physical_goods_parameters
	V4:job_requested_physical_goods_parameters

Include Page

	V4:job_requested_expense_parameters
	V4:job_requested_expense_parameters

Include Page

	V4:job_requested_activity_services_parameters
	V4:job_requested_activity_services_parameters

Restrictions

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

Response Data

Include Page

	V4:job_replace_physical_goods_complete
	V4:job_replace_physical_goods_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

{
    "token":"4A2E69938DFE42DA8BB16C9D9247B00C",
    "type_identifier":{"name":"Replace Physical Goods"},    
    "accounts_receivable_identifier":{"number":"ACR0000000266"},        
    "location_identifier":{"type":"HOME"},

owned_by_group":

contact_email":"m_michael@crm.com",

"billing_terms":
   {

"billing_term_scheme_identifier":{"id":"F3057AAF86104FF591C4C3131E731807"},
       "

alternative_code

price_plan_identifier":{"id":

MG

E2858AC591A04CF58912A9636787139C"

,

},

community

assigned_

name

to":

"Community",

"name

"user_identifier":{"username":

Main Group

MPAdministrator"

,

}
    },
   "requested_replaced_physical_goods_set":
    [

"description":

"Main

Group",

    {
            "

id

installed_item_identifier":{"serial_number":

1

modem_replace_003"}
        }

},

]
}

Response:

{
        "

description

data":

null,


        {
            "

rating_state

notes":

"PENDING"

null,
            "

expenses

contact_

set

phone": null,
            "log_information":

[

],

udf

created_

date

by_

2

unit":

null,

"udf_date_1":

null,

"udf_date_4": null,

contact

alternative_

email

code": "

m_michael@crm.com

adminunit",

"udf_date_3

        "group_name":

null

"Main Group",

"physical_goods_replacements_set":

        "community_name": "Community",

[

],

    "name": "Admin Unit",

"udf_float_3":

null,

udf_float_4

description": "admin

null,

unit",

"estimated_completion_time":

{

"id": "1"

"time_period_uot": "HOURS"

},
                "

time

updated_

period

by_

value

unit":

10

},

"service_request":

null,

udf

alternative_

float_1

code":

null

"adminunit",

"billing_terms":

        "group_name": "Main Group",

{

billing

community_

frequency

name":

null

"Community",

"billing_term_scheme

    "name": "Admin Unit",

{

      "description": "admin

unit",

"code":

"PJBTS",

        "id": "1"

"name":

"P

Job

Billing

Term

Scheme"

},

billing

created_

type

date": "

NORMAL

2016-08-24T09:39:51",

id

updated_date": "

F3057AAF86104FF591C4C3131E731807

2016-08-24T09:40:12",
                "updated_by_user":

"life_cycle_state":

"EFFECTIVE",

"classification":

"JOBS"

           "person_name": "CRM COM",

},

allowed_cancel_date

id":

null,

"1",
                    "

billing_cycle_day

username":

null,

"MPAdministrator"

"agreement_date": "2016-08-24T00:00:00"

},
                "

effective

created_by_

date

user":

"2016-08-24T00:00:00",

"price_plan":

{

"person_name": "CRM COM",
                    "

code

id": "

MPP

1",
                    "

name

username": "MPAdministrator"

Main

Price

Plan",

"effective_date": "2016-07-21T00:00:00",

},

"description

"requested_physical_goods_set":

"Main

Price

Plan",

"id": "E2858AC591A04CF58912A9636787139C"

 ],
            "type":

"type":

"BASE",

    {
                "

expiration

alternative_

date

code": "RPG",

null

}

"name": "Replace Physical Goods",
                "

id

fulfillment_scope": "

7C7AE4F608B0406497F056E4E422DE5A

REPLACE_PHYSICAL_GOODS",
                "

expiration_date

description": null,
                "

binding

fulfillment_

information

method":

null

"BASED_ON_ORDERED_ITEMS",

},

"id": "E859291E838947F58C09BD0799E3613D"

"udf_float_2": null

 },
            "

start_date

number": "

2016-08-24T09:39:51

J00000418",
            "

assigned_to

id": "B26FC357BDFD46349EB4F136235A2204",

{

 "actual_completed_date": null,

unit

requested_expenses_set":
            [

{

         ],
            "

alternative

udf_string_

code

2":

"adminunit",

null,
            "udf_string_3": null,
            "

group

udf_string_

name

4":

"Main Group",

 null,
            "udf_string_5": null,
            "

community

privacy_

name

level":

"Community"

null,
            "udf_string_1": null,

"name

     "life_cycle_state": "

Admin Unit

DRAFT",
            "activities_set":

"description": "admin unit",

     [
            ],
            "

id

physical_goods_set":

"1"

},

],

"user":

    "time_overdue":
            {

"person_name

"time_period_uot":

"CRM COM",

null,
                "time_period_value": null

"id":

"1",

        },
            "

email

udf_string_6":

"dev@crm.com"

null,
            "udf_string_7": null,

"username

    "udf_string_8":

"MPAdministrator"

null,
            "status":

}

},

accounts

alternative_

receivable

code":

{

"IP",
                "

number

name": "

ACR0000000266

Draft",
                "

name

description":

"ACR0000000266 Polen Mayiar"

null,
                "id": "

1E3E7AC4D2FA49458E2FFDE6912B7728

C9AFA1C35F628CB2B279C98D4CA45C5E",
                "life_cycle_state": "

ACTIVE

DRAFT"

,

},

"account_owner":

         "owned_by_group":

{

    {
                "

company

alternative_

profile

code":

null,

"MG",

company

community_name":

null

"Community",

"name": "

Polen

Main

Mayiar

Group",

last_name

description": "

Mayiar

Main Group",


                "id": "

1E66220195AF49A1BE8B0BDFB92F6D91

1"

,

},

"life_cycle_state":

"FINANCIAL",

"description": null,
            "

middle

rating_

name

state":

null

"PENDING",
            "expenses_set":

"title": null,

     [
            ],

"type":

"PERSON",

       "udf_date_2": null,
            "

first

udf_date_

name

1":

"Polen"

null,

"demographics

"udf_date_4": null,
            "contact_email": "m_michael@crm.com",

{

"udf_date_3": null,

"name_day

"physical_goods_replacements_set":
            [

{

 ],
            "udf_float_3": null,

month

udf_float_4": null,
            "estimated_completion_time":

"day":

null

              "time_period_uot": "HOURS",

},

"time_period_value": 10
            },
            "

id

service_

number

request":

"582649"

null,
            "udf_float_1": null,
            "

gender

billing_terms":

"MALE",


            {
                "

country

billing_

of_residence

frequency": null,
                "billing_term_scheme":

{

        {
                    "

alternative_

code": "

CYP

PJBTS",

"three_character_code

"name": "

CYP",

P Job Billing

Term Scheme",
                    "

name

billing_type": "

CYPRUS

NORMAL",


                    "id": "

181

F3057AAF86104FF591C4C3131E731807",

"life_cycle_state": "EFFECTIVE",

"two_character_code":

"CY"

              "classification": "JOBS"

},

},

date

allowed_

of

cancel_

birth

date": null,
                "billing_cycle_day": null,

{

           "agreement_date": "2016-08-24T00:00:00",
                "

month

effective_date":

null

"2016-08-24T00:00:00",
                "price_plan":

"year":

null,

day

code":

null

"MPP",
                    "name": "Main Price

},

Plan",
                    "

industry

effective_

sector

date":

null

"2016-07-21T00:00:00",

"passport_number

"description":

null,

"Main Price Plan",

industry

id":

null

"E2858AC591A04CF58912A9636787139C",

"social_security_number

"type":

null,

"BASE",

id_issued_by_country

expiration_date": null

,

},

"passport_issued_by_country

 "id":

null

"7C7AE4F608B0406497F056E4E422DE5A",
                "expiration_date": null,

}

              "binding_information": null

}

},
            "

time

udf_

to

float_

completion

2": null,

{

"start_date": "2016-08-24T09:39:51",
            "

time

assigned_

period_uot

to":

"HOURS",

"time_period_value":

9.994166666666667

           "unit":

},

"requested_activity_services_set":

[

          "alternative_code": "adminunit",

],

"requested_physical_goods_replacement_set":

      "group_name": "Main Group",

[

{

"community_name": "Community",
                    "

installed_item

name": "Admin Unit",

{

  "description": "admin unit",
                    "

product

id": "1"
                },

{

          "user":
                {

"code":

"Modem",

                  "person_name": "CRM COM",

"product_type":

            "id": "1",

{

     "email": "dev@crm.com",
                    "username": "MPAdministrator"

"service_type": null,

            }
            },
            "

used

accounts_

for_provisioning

receivable":

true,

{
                "

alternative_code

number": "

Physical Good

ACR0000000266",
                "name": "ACR0000000266 Polen Mayiar",
                "

composition_method

id": "

FLAT

1E3E7AC4D2FA49458E2FFDE6912B7728",
                "life_cycle_state": "ACTIVE",
                "

name

account_owner":

"Physical Good",

               {
                    "

description

company_profile": null,
                    "company_name": null,

"id":

"5B6DAF4AD7C94C4D9C3B49950E10B256",

        "name":

"Polen Mayiar",
                    "

classification

last_name": "

PHYSICALGOODS

Mayiar",
                    "id": "1E66220195AF49A1BE8B0BDFB92F6D91",

"physical_good_type

      "life_cycle_state": "

TRACEABLE

FINANCIAL",
                    "middle_name": null,

},

       "title": null,
                    "

alternative_code

type": "

M_2

PERSON",
                    "first_name": "Polen",

"description":

"Modem",

             "demographics":

"id":

"01BEEA0C9B7246E79CAF6E569A8C6ECF"

},

    "name_day":

"alternative_code":

"modem_replace_003",

"serial_number

       "month":

"modem_replace_003"

null,
                            "

id

day":

"454268B57DEF430F8ED20848FA63EA9C",

null
                        },

"state": "EFFECTIVE"

},

"id_number": "582649",
                        "

warranty_expiration_date

gender": "

2017-08-24T09:11:02

MALE",
                        "

warranty

country_of_

policy

residence":
                        {

"number

    "alternative_code": "

1

CYP",
                            "

alternative

three_character_code": "

NSS

CYP",
                            "name": "CYPRUS"

New

Subscription

Sales",

                         "id": "

3C6F0E199A1F420BB74EA8EBF0DC0BF4

181",
                            "

life

two_

cycle

character_

state

code": "

EFFECTIVE

CY"
                        },

"id

    "date_of_birth":

"A15A8A86BFCD46FCA95945EB91C73155"

}

],

location

month": null,

"category": null,

expected_completion_date

year":

"2016-08-24T19:39:51"

 null,

},

status

day": null

{

"code": "OK"

},

"description

            "industry_sector":

""

null,

"message": ""

           "passport_number": null,

}

POST jobs/replace_physical_goods/create

This method creates a job of fulfillment scope Replace Physical Goods. Single job can be created by each call. Only customer jobs can be created through this method.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

type_identifier
(mandatory)

...

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

...

status_identifier
(optional)

...

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:

...

category_identifier
(optional)

...

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

...

(mandatory)

...

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

...

contact_email

(optional)

...

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

...

contact_phone

(optional)

...

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

...

description
(optional)

...

notes
(optional)

...

start_date
(optional)

...

owned_by_group_identifier
(optional)

...

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

...

privacy_level_identifier
(optional)

...

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

...

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

...

udf_string_1

(optional)

...

User Defined Field of type String

...

udf_string_2

(optional)

...

User Defined Field of type String

...

udf_string_3

(optional)

...

User Defined Field of type String

...

udf_string_4

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

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)

...

estimated_completion_time
(semi-optional)

...

The billing terms of the job to be created. This information is applicable and mandatory only if the job is billable

...

requested_replaced_physical_goods_set

(mandatory)

...

The requested physical goods (installed items) that will be replaced as part of fulfilling this job. The traceable physical goods are filtered based on the traceable physical goods which are owned by the account owner and are not used in any subscriptions

...

requested_physical_goods_set

(optional)

...

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.

...

requested_expenses_set

(optional)

...

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

...

requested_activity_services_set

(optional)

...

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.

...

fields_set

(optional)

...

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

...

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Response:

         "industry": null,
                        "social_security_number": null,
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "time_to_completion":
            {
                "time_period_uot": "HOURS",
                "time_period_value": 9.994166666666667
            },
            "requested_activity_services_set":
            [
            ],
            "requested_physical_goods_replacement_set":
            [
                {
                    "installed_item":
                    {
                        "product":
                        {
                            "code": "Modem",
                            "product_type":
                            {
                                "service_type": null,
                                "used_for_provisioning": true,
                                "alternative_code": "Physical Good",
                                "composition_method": "FLAT",
                                "name": "Physical Good",
                                "description": null,
                                "id": "5B6DAF4AD7C94C4D9C3B49950E10B256",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "TRACEABLE"
                            },
                            "alternative_code": "M_2",
                            "description": "Modem",
                            "id": "01BEEA0C9B7246E79CAF6E569A8C6ECF"
                        },
                        "alternative_code": "modem_replace_003",
                        "serial_number": "modem_replace_003",
                        "id": "454268B57DEF430F8ED20848FA63EA9C",
                        "state": "EFFECTIVE"
                    },
                    "warranty_expiration_date": "2017-08-24T09:11:02",
                    "warranty_policy":
                    {
                        "number": "1",
                        "alternative_code": "NSS",
                        "name": "New Subscription Sales",
                        "id": "3C6F0E199A1F420BB74EA8EBF0DC0BF4",
                        "life_cycle_state": "EFFECTIVE"
                    },
                    "id": "A15A8A86BFCD46FCA95945EB91C73155"
                }
            ],
            "location": null,
            "category": null,
            "expected_completion_date": "2016-08-24T19:39:51"
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

POST jobs/replace_physical_goods/update

...

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)

String

The description of the new job

notes
(optional)

String

The 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

contact_phone

(optional)

String

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

start_date
(optional)

Date

The date that the activity is created

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)

Date

The 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 Object

The 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 is still draft or pending and if the job is billable

assigned_to
(optional)

Assigned to object

The assignment information for the retrieved job. Assign to information is mandatory to be specified, unless if it is set automatically through ACR rules.

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

requested_physical_goods_replacements_set

(optional)

Set of Requested Physical Good Replacements Objects

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

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

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

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

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

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

...

Versions Compared

Old Version 5

New Version 6

Key

POST jobs/replace_physical_goods/create

Resource URL

Parameters

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

Restrictions

Response Data

Examples

POST jobs/replace_physical_goods/create

Resource URL

Parameters

Restrictions

Response Data

Examples

POST jobs/replace_physical_goods/update

Page Comparison

Versions Compared

Old Version 5

New Version 6

Key

POST jobs/replace_physical_goods/create

Resource URL

Parameters

Anchorjob_create referred objects parametersjob_create referred objects parametersReferred Parameter Objects Data

Restrictions

Response Data

Examples

POST jobs/replace_physical_goods/create

Resource URL

Parameters

Restrictions

Response Data

Examples

POST jobs/replace_physical_goods/update

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