Page Comparison

Tip
Available from CRM.COM R14.0.0

Excerpt
This method returns information related to the latest jobs of fulfillment scope Activate Subscription. Multiple jobs are returned by each call. Results are sorted based on the date that they were updated in a descending order

...

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 to 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. Only job types classified as Activate Subscription can be specified. The allowed job type identifier fields are the following:

Include Page

	V4:job_type_identifier
	V4:job_type_identifier

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise, the results will begin at the provided offset number

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

theme	Confluence
language	javascript
linenumbers	true

{
    "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-03-22T07:28:30",
                "updated_date": "2016-03-22T07:34:06",
                "updated_by_user": {
                    "person_name": "Persy Xe",
                    "id": "E59E9C8A474D45C687D37047EF230FAC",
                    "email": "p_xenopoulou@crm.com",
                    "username": "pxenopoulou"
                },
                "created_by_user": {
                    "person_name": "Persy Xe",
                    "id": "E59E9C8A474D45C687D37047EF230FAC",
                    "email": "p_xenopoulou@crm.com",
                    "username": "pxenopoulou"
                }
            },
            "requested_physical_goods_set": [
                {
                    "product": {
                        "code": "Antenna",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": false,
                            "alternative_code": "001",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Equipment",
                            "description": null,
                            "id": "EQ",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "NONTRACEABLE"
                        },
                        "alternative_code": "A",
                        "description": "Antenna",
                        "id": "872C558604704AA29D8512A70B608573",
                        "priority_level": null
                    },
                    "quantity": 1,
                    "notes": null,
                    "id": "B984D937A39E45978B634F72D28BCC57"
                }
            ],
            "expiration_date": null,
            "type": {
                "billing_method": null,
                "alternative_code": "AS",
                "name": "Activate Subscription",
                "fulfillment_scope": "ACTIVATE_SUBSCRIPTION",
                "description": null,
                "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
                "id": "5D0C13F12EC9496283CF973FD0FAD56A",
                "billing_directive": "BILLABLE"
            },
            "number": "J00000074",
            "bills_set": [
                {
                    "number": "131",
                    "from_date": "2016-03-22T07:35:37",
                    "to_date": null,
                    "currency": {
                        "suffix_symbol": null,
                        "prefix_symbol": "£",
                        "decimal_part_name": null,
                        "code": "GBP",
                        "integer_part_name": null,
                        "id": "9",
                        "life_cycle_state": "EFFECTIVE"
                    },
                    "id": "88157C45C23E4C76AEFC54F3609C56D8",
                    "life_cycle_state": "POSTED",
                    "total_billed_amount": 30,
                    "total_amount_to_be_paid": 30,
                    "bill_status": null
                }
            ],
            "id": "94B6118FF9A24BFF99A8274F4A9E868D",
            "actual_completed_date": "2016-03-22T07:34:04",
            "requested_expenses_set": [
                {
                    "product": {
                        "code": "Expense 2",
                        "product_type": {
                            "service_type": "EXPENSE",
                            "used_for_provisioning": false,
                            "alternative_code": "006",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Fees",
                            "description": "Fees One Time Services",
                            "id": "6",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "E2",
                        "description": "Expense 2",
                        "id": "1CEB8D2B86134B138469F8F3E12EB792",
                        "priority_level": null
                    },
                    "id": "872A5C74321443659F9B780A63EFF0C1"
                },
                {
                    "product": {
                        "code": "Expense 1",
                        "product_type": {
                            "service_type": "EXPENSE",
                            "used_for_provisioning": false,
                            "alternative_code": "006",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Fees",
                            "description": "Fees One Time Services",
                            "id": "6",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "E1",
                        "description": "Expense 1",
                        "id": "A9917A7895044BEF9499DD6958539D33",
                        "priority_level": null
                    },
                    "id": "8724A2CFABB7457B85E96E1C57B7ECB7"
                }
            ],
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "privacy_level": null,
            "udf_string_1": "1",
            "life_cycle_state": "COMPLETED",
            "activities_set": [
                {
                    "number": "57",
                    "contact_information": {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Jane Jade",
                        "last_name": "Jade",
                        "id": "30967D1C42F841D5A2D368C5005BDC48",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": "Mrs",
                        "type": "PERSON",
                        "first_name": "Jane",
                        "demographics": {
                            "name_day": {
                                "month": 9,
                                "day": 26
                            },
                            "id_number": "54848484",
                            "gender": "FEMALE",
                            "country_of_residence": {
                                "alternative_code": "IRN",
                                "three_character_code": null,
                                "name": "IRAN (ISLAMIC REPUBLIC OF)",
                                "id": "231",
                                "two_character_code": null
                            },
                            "date_of_birth": {
                                "month": 10,
                                "year": 1981,
                                "day": 19
                            },
                            "industry_sector": {
                                "alternative_code": "FIN",
                                "name": "FINANCIALS",
                                "id": "61FD1DE51A932732C059FE9CFB6B38B3"
                            },
                            "passport_number": "J003430",
                            "industry": null,
                            "social_security_number": "856565",
                            "id_issued_by_country": {
                                "alternative_code": "CYP",
                                "three_character_code": "CYP",
                                "name": "CYPRUS",
                                "id": "181",
                                "two_character_code": "CY"
                            },
                            "passport_issued_by_country": {
                                "alternative_code": "CYP",
                                "three_character_code": "CYP",
                                "name": "CYPRUS",
                                "id": "181",
                                "two_character_code": "CY"
                            }
                        }
                    },
                    "id": "CEC1D0348DD24DFABF02C78751833CCC",
                    "life_cycle_state": "COMPLETED",
                    "type": {
                        "alternative_code": "I",
                        "name": "Installation",
                        "description": "test",
                        "id": "47675EE2507BC9237F144B46221F7B17"
                    }
                }
            ],
            "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": "3",
                "name": "Closed",
                "description": null,
                "id": "B5BE4505EE41A8829AAA7790F9BACE49",
                "life_cycle_state": "COMPLETED"
            },
            "owned_by_group": {
                "alternative_code": "MG",
                "community_name": "Community",
                "name": "Main Group",
                "description": "Main Group",
                "id": "1"
            },
            "description": null,
            "rating_state": "COMPLETED",
            "expenses_set": [
                {
                    "product": {
                        "code": "Expense 2",
                        "product_type": {
                            "service_type": "EXPENSE",
                            "used_for_provisioning": false,
                            "alternative_code": "006",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Fees",
                            "description": "Fees One Time Services",
                            "id": "6",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "E2",
                        "description": "Expense 2",
                        "id": "1CEB8D2B86134B138469F8F3E12EB792",
                        "priority_level": null
                    },
                    "id": "EE760FC089A840D8B60EF511E7BD00F1"
                },
                {
                    "product": {
                        "code": "Expense 1",
                        "product_type": {
                            "service_type": "EXPENSE",
                            "used_for_provisioning": false,
                            "alternative_code": "006",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Fees",
                            "description": "Fees One Time Services",
                            "id": "6",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "E1",
                        "description": "Expense 1",
                        "id": "A9917A7895044BEF9499DD6958539D33",
                        "priority_level": null
                    },
                    "id": "18DB83F3DAAD4D2DBDB3341989E7B9D5"
                }
            ],
            "subscription": {
                "number": "S0000000005",
                "first_activated_date": "2016-02-09T12:39:59",
                "rating_state": "PENDING",
                "accounts_receivable": {
                    "number": "0000000005",
                    "name": "0000000005 Jane Jade",
                    "id": "67A6F0E477484F2CB37AA52D3D9CD617",
                    "life_cycle_state": "ACTIVE",
                    "account_owner": {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Jane Jade",
                        "last_name": "Jade",
                        "id": "30967D1C42F841D5A2D368C5005BDC48",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": "Mrs",
                        "type": "PERSON",
                        "first_name": "Jane",
                        "demographics": {
                            "name_day": {
                                "month": 9,
                                "day": 26
                            },
                            "id_number": "54848484",
                            "gender": "FEMALE",
                            "country_of_residence": {
                                "alternative_code": "IRN",
                                "three_character_code": null,
                                "name": "IRAN (ISLAMIC REPUBLIC OF)",
                                "id": "231",
                                "two_character_code": null
                            },
                            "date_of_birth": {
                                "month": 10,
                                "year": 1981,
                                "day": 19
                            },
                            "industry_sector": {
                                "alternative_code": "FIN",
                                "name": "FINANCIALS",
                                "id": "61FD1DE51A932732C059FE9CFB6B38B3"
                            },
                            "passport_number": "J003430",
                            "industry": null,
                            "social_security_number": "856565",
                            "id_issued_by_country": {
                                "alternative_code": "CYP",
                                "three_character_code": "CYP",
                                "name": "CYPRUS",
                                "id": "181",
                                "two_character_code": "CY"
                            },
                            "passport_issued_by_country": {
                                "alternative_code": "CYP",
                                "three_character_code": "CYP",
                                "name": "CYPRUS",
                                "id": "181",
                                "two_character_code": "CY"
                            }
                        }
                    }
                },
                "id": "342882AE69284343BEDB13A1091AC8CA",
                "life_cycle_state": "REGRETTED",
                "type": {
                    "alternative_code": "normalsub",
                    "name": "Normal",
                    "description": null,
                    "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
                }
            },
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "contact_email": null,
            "udf_date_3": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "estimated_completion_time": {
                "time_period_uot": "DAYS",
                "time_period_value": 1
            },
            "service_request": null,
            "udf_float_1": null,
            "billing_terms": {
                "billing_frequency": null,
                "billing_term_scheme": {
                    "code": "PJBTS",
                    "name": "P Job Billing Term Scheme",
                    "billing_type": "NORMAL",
                    "id": "4DA32AA285FD43CE85256B970277E638",
                    "life_cycle_state": "EFFECTIVE",
                    "classification": "JOBS"
                },
                "allowed_cancel_date": null,
                "billing_cycle_day": null,
                "agreement_date": "2016-03-22T00:00:00",
                "effective_date": "2016-03-22T00:00:00",
                "price_plan": {
                    "code": "MPP",
                    "name": "Main Price Plan",
                    "effective_date": "2016-02-09T00:00:00",
                    "description": "Main Price Plan",
                    "id": "FF75A943141B43528BC96B11D687380D",
                    "type": "BASE",
                    "expiration_date": "2016-06-14T00:00:00"
                },
                "id": "F12CBD219CCA4941BA8B1DA590C3E679",
                "expiration_date": null,
                "binding_information": null
            },
            "udf_float_2": null,
            "start_date": "2016-05-22T07:28:30",
            "assigned_to": {
                "unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "user": {
                    "person_name": "Persy Xe",
                    "id": "E59E9C8A474D45C687D37047EF230FAC",
                    "email": "p_xenopoulou@crm.com",
                    "username": "pxenopoulou"
                }
            },
            "accounts_receivable": {
                "number": "0000000005",
                "name": "0000000005 Jane Jade",
                "id": "67A6F0E477484F2CB37AA52D3D9CD617",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": "Jane Jade",
                    "last_name": "Jade",
                    "id": "30967D1C42F841D5A2D368C5005BDC48",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": "Mrs",
                    "type": "PERSON",
                    "first_name": "Jane",
                    "demographics": {
                        "name_day": {
                            "month": 9,
                            "day": 26
                        },
                        "id_number": "54848484",
                        "gender": "FEMALE",
                        "country_of_residence": {
                            "alternative_code": "IRN",
                            "three_character_code": null,
                            "name": "IRAN (ISLAMIC REPUBLIC OF)",
                            "id": "231",
                            "two_character_code": null
                        },
                        "date_of_birth": {
                            "month": 10,
                            "year": 1981,
                            "day": 19
                        },
                        "industry_sector": {
                            "alternative_code": "FIN",
                            "name": "FINANCIALS",
                            "id": "61FD1DE51A932732C059FE9CFB6B38B3"
                        },
                        "passport_number": "J003430",
                        "industry": null,
                        "social_security_number": "856565",
                        "id_issued_by_country": {
                            "alternative_code": "CYP",
                            "three_character_code": "CYP",
                            "name": "CYPRUS",
                            "id": "181",
                            "two_character_code": "CY"
                        },
                        "passport_issued_by_country": {
                            "alternative_code": "CYP",
                            "three_character_code": "CYP",
                            "name": "CYPRUS",
                            "id": "181",
                            "two_character_code": "CY"
                        }
                    }
                }
            },
            "time_to_completion": {
                "time_period_uot": null,
                "time_period_value": null
            },
            "requested_activity_services_set": [
                {
                    "product": {
                        "code": "Installation Service",
                        "product_type": {
                            "service_type": "ONETIME",
                            "used_for_provisioning": false,
                            "alternative_code": "I",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Services",
                            "description": null,
                            "id": "7A2F73F07F944CBAB8C5ACDA1A7879B4",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "IS",
                        "description": "Installation Service",
                        "id": "DB4875A4EB7C46BF94AD72169B36FD90",
                        "priority_level": null
                    },
                    "activity_type": {
                        "alternative_code": "I",
                        "name": "Installation",
                        "description": "test",
                        "id": "47675EE2507BC9237F144B46221F7B17"
                    },
                    "id": "7C65DFB18D8A468BA1455A19ABE4F054"
                }
            ],
            "location": {
                "apartment_number": "120",
                "care_of": "Austin Jade",
                "country": {
                    "alternative_code": "CYP",
                    "three_character_code": "CYP",
                    "name": "CYPRUS",
                    "id": "181",
                    "two_character_code": "CY"
                },
                "municipality": "Nicosia Municipality",
                "type": "HOME",
                "udf_date_2": null,
                "udf_date_1": null,
                "street_name": "Kennedy Av",
                "udf_date_4": null,
                "udf_date_3": null,
                "udf_float_3": null,
                "udf_float_4": null,
                "po_box_postal_code": null,
                "udf_string_15": null,
                "udf_string_16": null,
                "udf_string_13": null,
                "udf_string_14": null,
                "udf_string_11": null,
                "udf_string_12": null,
                "id": "40ECC24A79D7432E81EA2E9909CDD8D3",
                "state": "Active",
                "udf_string_10": null,
                "floor": 1,
                "udf_float_1": null,
                "udf_float_2": null,
                "area": "Acropoli",
                "udf_string_2": null,
                "udf_string_3": null,
                "udf_string_4": null,
                "udf_string_5": null,
                "udf_string_1": null,
                "po_box": null,
                "town_city": "Nicosia City",
                "district": "Nicosia District",
                "street_number": "415",
                "postal_code": "1016",
                "udf_string_6": null,
                "udf_string_7": null,
                "udf_string_8": null,
                "udf_string_9": null
            },
            "category": null,
            "expected_completion_date": "2016-03-23T07:28:30"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Expand

title	Example 2

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "data": [
        {
            "number": "J00000959",
            "description": null,
            "id": "6CB704E5F3F94DF5968895CB5E91CB7E",
            "life_cycle_state": "COMPLETED"
        },
        {
            "number": "J00000953",
            "description": null,
            "id": "BE6A22404D83465090018406F37AFBEE",
            "life_cycle_state": "COMPLETED"
        },
        {
            "number": "J00000952",
            "description": null,
            "id": "4DBB60A7BEA44A31B26D95DB1F7C6198",
            "life_cycle_state": "COMPLETED"
        },
        {
            "number": "J00000840",
            "description": null,
            "id": "C4A30CCA7AFC4926B86FFBFBF720C723",
            "life_cycle_state": "COMPLETED"
        },
        {
            "number": "J00000766",
            "description": null,
            "id": "974830C425AC40AC81F10C2747D5CB44",
            "life_cycle_state": "COMPLETED"
        },
        {
            "number": "J00000707",
            "description": null,
            "id": "92A0E7E10E8740539ACA49C397075FD3",
            "life_cycle_state": "COMPLETED"
        },
        {
            "number": "J00000659",
            "description": null,
            "id": "1B53764B41EF4FA4A8C93BEC7E282193",
            "life_cycle_state": "IN_PROGRESS"
        },
        {
            "number": "J00000560",
            "description": null,
            "id": "B0E3630BAD6E424784E68ADDBB11D79D",
            "life_cycle_state": "PENDING"
        },
        {
            "number": "J00000561",
            "description": null,
            "id": "15AD060D2C7A4398A8C8555637B5CA0E",
            "life_cycle_state": "PENDING"
        },
        {
            "number": "J00000516",
            "description": "Activate Subscription S61010 for ACR0000000404",
            "id": "0F6EE44762144A9EBBD019565777F634",
            "life_cycle_state": "DRAFT"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 1

New Version Current

Key