Versions Compared

Version Old Version 5 New Version 6
Changes made by

Marios Michael

Marios Michael

Saved on

Key

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

Available from CRM.COM R11.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

...

Expand
titleExample 1

HTTP Method: GET 

Request:

Response:

{ "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" }, "owned_by_group": { "alternative_code": "MG", "community_name": "Community", "name": "Main Group", "description": "Main Group", "id": "1"
Code Block
 

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)

StringThe description of the new job

notes
(optional)

StringThe notes of the new job

start_date
(optional)

DateThe 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)

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

assigned_to
(mandatory)		Assigned to objectThe 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
titleExample 1

HTTP Method: POST 

Request:

Body:

{
    "token":"4A2E69938DFE42DA8BB16C9D9247B00C",
    "type_identifier":{"name":"Replace Physical Goods"},    
    "accounts_receivable_identifier":{"number":"ACR0000000266"},        
    "location_identifier":{"type":"HOME"},    
    "contact_email":"m_michael@crm.com",
    "
description
billing_terms":
null,
   {
"rating_state": "PENDING"
"billing_term_scheme_identifier":{"id":"F3057AAF86104FF591C4C3131E731807"},
"expenses_set":
"price_plan_identifier":{"id":"E2858AC591A04CF58912A9636787139C"}   
   },
    "assigned_to":
[
    {
],
"user_identifier":{"username":"MPAdministrator"}
    },
"udf_date_2
"requested_replaced_physical_goods_set":
null,
    [
"udf_date_1": null,
{
            "
udf
installed_
date
item_
4
identifier":
null, "contact_email": "m_michael@crm.com",
{"serial_number":"modem_replace_003"}
        }
"udf_date_3": null, 
 ]
}

Response:

{
"physical_goods_replacements_set
"data":
        {
[
]
"notes": null,
            "
udf
contact_
float_3
phone": null,
            "
udf
log_
float_4
information":
null,
            {
"estimated_completion_time":
{
  "created_by_unit":
"time_period_uot":
"HOURS",
 {
"time_period_value":
10
    "alternative_code": "adminunit",
},
             "
service
group_
request
name": "Main
null
Group",
"udf_float_1
        "community_name":
null
"Community",
"billing_terms":
        "name": "Admin Unit",
{
                  "
billing_frequency
description":
null,
"admin unit",
"billing_term_scheme
  "id": "1"
{
 
},
                
"
code
updated_by_unit":
"PJBTS",
"name": "P Job Billing Term Scheme", 
{
                    "
billing
alternative_
type
code": "
NORMAL
adminunit",
                    "
id
group_name": "
F3057AAF86104FF591C4C3131E731807
Main Group",
                    "
life
community_
cycle_state
name": "
EFFECTIVE
Community",
                    "
classification
name": "
JOBS"
Admin Unit",
},
"description": "admin unit",
                    "
allowed_cancel_date
id":
null,
"1"
"billing_cycle_day": null
},
                "
agreement
created_date": "2016-08-
24T00
24T09:
00
39:
00
51",
                "
effective
updated_date": "2016-08-
24T00
24T09:
00
40:
00
12",
                "
price
updated_by_
plan
user":
                {
                    "
code
person_name": "
MPP
CRM COM",
                    "
name
id": "
Main Price Plan
1",
                    "
effective_date
username": "
2016-07-21T00:00:00",
MPAdministrator"
                },
"description":
"Main
Price
Plan",
     "created_by_user":
"id": "E2858AC591A04CF58912A9636787139C",
 {
                    "
type
person_name": "
BASE
CRM COM",
                    "
expiration_date
id":
null
"1",
},
    
"username": "MPAdministrator"
"id":
"7C7AE4F608B0406497F056E4E422DE5A",
     }
"expiration_date": null
 },
"binding_information
"requested_physical_goods_set":
null
},
[
"udf_float_2": null
],
            "
start_date
type":
"2016-08-24T09:39:51",
"assigned_to": 
  
{
                "
unit
alternative_code": "RPG",
{
 "name": "Replace Physical Goods",
                "
alternative
fulfillment_
code
scope": "
adminunit
REPLACE_PHYSICAL_GOODS",

                "
group_name
description":
"Main Group", 
null,
                "
community
fulfillment_
name
method": "
Community
BASED_ON_ORDERED_ITEMS",
                "id": "E859291E838947F58C09BD0799E3613D"
"name":
"Admin
Unit",
        },
            "
description
number": "
admin unit
J00000418",
            
"id": "
1
B26FC357BDFD46349EB4F136235A2204",
}, 
"actual_completed_date": null,
"user
"requested_expenses_set":
            [
{
         ],
            "
person
udf_string_
name
2":
"CRM COM"
null,
            "udf_string_3": null,
"id":
"1",
     
"udf_string_4": null,
            "
email
udf_string_5":
"dev@crm.com", 
null,
            "
username
privacy_level":
"MPAdministrator"
null,
            "udf_string_1": null,
}
}
"life_cycle_state": "DRAFT",
            "
accounts
activities_
receivable
set":
{
[
            ],
"number":
"ACR0000000266",
        "physical_goods_set":
            [
"name":
"ACR0000000266
Polen
Mayiar",
    ],
            "
id
time_overdue":
"1E3E7AC4D2FA49458E2FFDE6912B7728",
            {
                "
life
time_
cycle
period_
state
uot":
"ACTIVE"
null,
                "
account
time_period_
owner
value": null
            },
{
          "udf_string_6": null,
            "
company
udf_string_
profile
7": null,
"company_name
"udf_string_8": null,
            "status":
"name":
"Polen
Mayiar",
   
{
                "
last
alternative_
name
code": "
Mayiar
IP",

                "
id
name": "
1E66220195AF49A1BE8B0BDFB92F6D91
Draft",
"life_cycle_state
"description":
"FINANCIAL", 
null,
                "
middle_name
id":
null
"C9AFA1C35F628CB2B279C98D4CA45C5E",
                "life_cycle_state": "DRAFT"
"title": null,
          },
            "
type
owned_by_group":
"PERSON",

            {
                "
first
alternative_
name
code": "
Polen
MG",
"demographics
"community_name": "Community",
                "name": "Main Group",
{
"name_day
"description": "Main Group",
                "id": "1"
{
        
},
            "
month
description": null,
            
"rating_state": "PENDING",
            
"
day
expenses_set":
null
            [
}
],
            "udf_date_2": null,
            "
id
udf_date_
number
1":
"582649"
null,
            "udf_date_4": null,
            "
gender
contact_email": "
MALE
m_michael@crm.com",

            
"
country
udf_
of
date_
residence
3": null,
            "physical_goods_replacements_set":
{
  [
            
],
            "
alternative
udf_float_
code
3":
"CYP"
null,
            
"udf_float_4": null,
            
"
three
estimated_
character
completion_
code
time":
"CYP",
            {
                "
name"
time_period_uot": "
CYPRUS
HOURS",
                "time_period_value": 10
"id": "181"
 },
            
"service_request": null,
            "
two
udf_
character
float_
code
1":
"CY"
null,
            "billing_terms":
}, 
 {
                "
date
billing_
of_birth
frequency": null,
                "billing_term_scheme":
{
        {
                    "
month
code":
null
"PJBTS",
"year
"name":
null,
"P Job Billing Term Scheme",
"day
"billing_type":
null
"NORMAL",
}, 
"id": "F3057AAF86104FF591C4C3131E731807",
                    
"
industry
life_cycle_
sector
state":
null, 
"EFFECTIVE",
                    "
passport_number
classification":
null,
"JOBS"
                },
"industry":
null,
        "allowed_cancel_date": null,
                "
social
billing_
security
cycle_
number
day": null,
"id_issued_by_country": null, 
"agreement_date": "2016-08-24T00:00:00",
                "
passport_issued_by_country
effective_date":
null
"2016-08-24T00:00:00",
                "price_plan":
}
             {
}
},
    "code": "MPP",
"time_to_completion":
{ 
"name": "Main Price Plan",
"time_period_uot
       "effective_date": "
HOURS
2016-07-21T00:00:00",
"time_period_value
   "description":
9.994166666666667
"Main Price Plan",
},
        "id": "E2858AC591A04CF58912A9636787139C",
"requested_activity_services_set":
[
    "type": "BASE",
],
             "
requested_physical_goods_replacement_set
expiration_date": null
[
     },
{
     "id": "7C7AE4F608B0406497F056E4E422DE5A",
                "
installed
expiration_
item
date": null,
                "binding_information": null
{
           
},
            "
product
udf_float_2": null,
            "start_date": "2016-08-24T09:39:51",
{
   "assigned_to":
            {
"code":
"Modem",
   "unit":
                {
"product_type":
            "alternative_code": "adminunit",
{
     "group_name": "Main 
Group",
                    
"
service
community_
type
name":
null
"Community",
                    "name": "Admin Unit",
"used_for_provisioning":
true,
          "description": "admin unit",
                    "
alternative_code
id": "
Physical Good
1"
,

                },
                "
composition_method
user":
"FLAT",

                {
                    "
name
person_name": "
Physical
CRM
Good
COM",
                    
"id": "1",
"description":
null,
           "email": "dev@crm.com",
                    "
id
username": "
5B6DAF4AD7C94C4D9C3B49950E10B256",
MPAdministrator"
                }
            },
"classification":
"PHYSICALGOODS",
   "accounts_receivable":
            {
                "
physical_good_type
number": "
TRACEABLE
ACR0000000266",
                "name": "ACR0000000266 Polen Mayiar",
},
        
"id": "1E3E7AC4D2FA49458E2FFDE6912B7728",
                
"
alternative
life_cycle_
code
state": "
M_2
ACTIVE",
                "account_owner":
"description":
"Modem",
    
{
                    "
id
company_profile":
"01BEEA0C9B7246E79CAF6E569A8C6ECF"
null,
}
"company_name": null,
"alternative_code
"name": "
modem_replace_003
Polen Mayiar",
                    
"
serial
last_
number
name": "
modem_replace_003
Mayiar",
                    
"id": "
454268B57DEF430F8ED20848FA63EA9C
1E66220195AF49A1BE8B0BDFB92F6D91",

                    "life_cycle_state": "
EFFECTIVE
FINANCIAL",
}
"middle_name": null,
                    "
warranty_expiration_date
title":
"2017-08-24T09:11:02"
null,
                    "
warranty_policy
type": "PERSON",
{
 "first_name": "Polen",
                    
"
number
demographics":
"1",
                    {
"alternative_code":
"NSS",
                   "name_day":
"name":
"New
Subscription
Sales",
                {
"id":
"3C6F0E199A1F420BB74EA8EBF0DC0BF4",
                   "month": null,
"life_cycle_state":
"EFFECTIVE"
},
  "day": null
"id":
"A15A8A86BFCD46FCA95945EB91C73155"
      },
}
], 
 "id_number": "582649",
"location":
null,
             "
category
gender":
null
"MALE",
"expected_completion_date": "2016-08-24T19:39:51"
            "country_of_residence":
},
"status":
      {
{
"code": "OK",
             "
description
alternative_code": "CYP",
"message":
""
}
}  

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
titleExample 1

HTTP Method: POST 

Request:

Body:

 

Response:

 
 "three_character_code": "CYP",
                            "name": "CYPRUS",
                            "id": "181",
                            "two_character_code": "CY"
                        },
                        "date_of_birth":
                        {
                            "month": null,
                            "year": null,
                            "day": null
                        },
                        "industry_sector": null,
                        "passport_number": null,
                        "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)		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

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)

DateThe 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)

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

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

...