Page Comparison

Tip
Available from CRM.COM R14.0.0

Excerpt
This method returns information related to the latest jobs of fulfillment scope Deactivate 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 Deactivate 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-22T09:33:46",
                "updated_date": "2016-03-22T09:54:22",
                "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": 2,
                    "notes": null,
                    "id": "F67861132C42403DB0090D8AE28D6285"
                }
            ],
            "expiration_date": null,
            "type": {
                "billing_method": null,
                "alternative_code": "DSd",
                "name": "Deactivate Subscriptions",
                "fulfillment_scope": "DEACTIVATE_SUBSCRIPTION",
                "description": "desc",
                "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
                "id": "A6AC882E06614B53B7F416D7D9604A35",
                "billing_directive": "BILLABLE"
            },
            "number": "J00000079",
            "bills_set": null,
            "id": "8B7DDDA186574E4EB7A8E6E131BF0803",
            "actual_completed_date": null,
            "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": "1894CD2BFB4A4439AD9A45B3DA841A29"
                }
            ],
            "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": "IN_PROGRESS",
            "activities_set": [
                {
                    "number": "60",
                    "contact_information": {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Andrea Black",
                        "last_name": "Black",
                        "id": "BF31C4A3FF68471586BB7F69E478AA91",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Andrea",
                        "demographics": {
                            "name_day": {
                                "month": null,
                                "day": null
                            },
                            "id_number": "1212153",
                            "gender": null,
                            "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": 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
                        }
                    },
                    "id": "6D8418C63054413CAB62F2EAC5F91CD2",
                    "life_cycle_state": "COMPLETED",
                    "type": {
                        "alternative_code": "I",
                        "name": "Installation",
                        "description": "test",
                        "id": "47675EE2507BC9237F144B46221F7B17"
                    }
                }
            ],
            "physical_goods_set": [
                {
                    "installed_item": null,
                    "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": 2,
                    "id": "37691EF24E5B448BB921A258E1DEC1A1"
                }
            ],
            "time_overdue": {
                "time_period_uot": "YEARS",
                "time_period_value": 1.494535519125683
            },
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "status": {
                "alternative_code": "2",
                "name": "Approved",
                "description": null,
                "id": "7A98FA9566534F1C82227985EA48F617",
                "life_cycle_state": "IN_PROGRESS"
            },
            "owned_by_group": {
                "alternative_code": "MG",
                "community_name": "Community",
                "name": "Main Group",
                "description": "Main Group",
                "id": "1"
            },
            "description": null,
            "rating_state": "PENDING",
            "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": "084DB81FF8704A49992CD2337365543D"
                }
            ],
            "subscription": {
                "number": "S0000000046",
                "first_activated_date": "2016-02-17T14:30:39",
                "rating_state": "COMPLETED",
                "accounts_receivable": {
                    "number": "ACR0000000048",
                    "name": "ACR0000000048 Andrea Black",
                    "id": "90E15C4BC4AB4FF28BEFBA7A79A3EC2E",
                    "life_cycle_state": "ACTIVE",
                    "account_owner": {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Andrea Black",
                        "last_name": "Black",
                        "id": "BF31C4A3FF68471586BB7F69E478AA91",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Andrea",
                        "demographics": {
                            "name_day": {
                                "month": null,
                                "day": null
                            },
                            "id_number": "1212153",
                            "gender": null,
                            "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": 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
                        }
                    }
                },
                "id": "A4140ED356C240B19166C1AC9DE09714",
                "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": "HOURS",
                "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": "93DCF45B649B4900995DAC63D1C9C8E1",
                "expiration_date": null,
                "binding_information": null
            },
            "udf_float_2": null,
            "start_date": "2015-10-22T09:33:46",
            "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": "ACR0000000048",
                "name": "ACR0000000048 Andrea Black",
                "id": "90E15C4BC4AB4FF28BEFBA7A79A3EC2E",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": "Andrea Black",
                    "last_name": "Black",
                    "id": "BF31C4A3FF68471586BB7F69E478AA91",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Andrea",
                    "demographics": {
                        "name_day": {
                            "month": null,
                            "day": null
                        },
                        "id_number": "1212153",
                        "gender": null,
                        "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": 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": 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": "8E06A8D6E534426BB653B62E68B66CEC"
                }
            ],
            "location": {
                "apartment_number": null,
                "care_of": null,
                "country": {
                    "alternative_code": "CYP",
                    "three_character_code": "CYP",
                    "name": "CYPRUS",
                    "id": "181",
                    "two_character_code": "CY"
                },
                "municipality": "Nicosia",
                "type": "HOME",
                "udf_date_2": null,
                "udf_date_1": null,
                "street_name": "Kapodistria",
                "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": "AB34B2AD111D41848B09E41DD4E8E76A",
                "state": "Active",
                "udf_string_10": null,
                "floor": null,
                "udf_float_1": null,
                "udf_float_2": null,
                "area": null,
                "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",
                "district": "Nicosia",
                "street_number": "121",
                "postal_code": "1122",
                "udf_string_6": null,
                "udf_string_7": null,
                "udf_string_8": null,
                "udf_string_9": null
            },
            "category": null,
            "expected_completion_date": "2016-03-22T10:33:46"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Expand

title	Example 2

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "data": [
        {
            "number": "J00000709",
            "description": null,
            "id": "BBF68E1F15BD4F3F8EACD1B3D52C7E86",
            "life_cycle_state": "COMPLETED"
        },
        {
            "number": "J00000367",
            "description": null,
            "id": "29DE7D00A4CE4A3CBCB8D9587C291CBF",
            "life_cycle_state": "IN_PROGRESS"
        },
        {
            "number": "J00000366",
            "description": null,
            "id": "AA4D1F795BCE48D182DE044CD06E1941",
            "life_cycle_state": "IN_PROGRESS"
        },
        {
            "number": "J00000352",
            "description": null,
            "id": "8B5D0A7B75C54A45B5D2BF2B18F74C08",
            "life_cycle_state": "IN_PROGRESS"
        },
        {
            "number": "J00000351",
            "description": null,
            "id": "CDD626F8977541CDBDB663C07BFA0CAA",
            "life_cycle_state": "PENDING"
        },
        {
            "number": "J00000079",
            "description": null,
            "id": "8B7DDDA186574E4EB7A8E6E131BF0803",
            "life_cycle_state": "IN_PROGRESS"
        },
        {
            "number": "J00000078",
            "description": null,
            "id": "9345E7A626DB4C9097CC0A179A0DF6AC",
            "life_cycle_state": "COMPLETED"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 1

New Version Current

Key