Page Comparison

...

Tip
Available from CRM.COM R14.4.0

Excerpt
This method returns the favorite items of a specific accounts receivable. Multiple favorite items are retrieved by this call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts Receivable Identifier

The identifier of the accounts receivable which owns the list of favorite items. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_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 from 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

Restrictions

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

...

Expand

title	Example 1

HTTP Method: GET

Request

Response

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
    "data": [
        {
            "number": null,
            "product": {
                "code": "1234",
                "product_type": {
                    "meter_reading_type": {
                        "unit_of_measurement": {
                            "alternative_code": "K",
                            "name": "Kilos",
                            "description": null,
                            "id": "42CACE552A58408F8143884E1C181057"
                        },
                        "alternative_code": "MTT",
                        "name": "MT TYPES",
                        "description": null,
                        "id": "4E951AFF3513471883161CF5E9029C3A",
                        "classification": "ONE_TIME_READING"
                    },
                    "service_type": null,
                    "used_for_provisioning": true,
                    "alternative_code": "test",
                    "udr_type": null,
                    "composition_method": "FLAT",
                    "name": "SMARTCARD",
                    "description": "SMARTCARD",
                    "id": "D6BE0209EC0149989A89972CE889DF8B",
                    "classification": "PHYSICALGOODS",
                    "physical_good_type": "TRACEABLE"
                },
                "alternative_code": "Smartcard 1",
                "description": "1234",
                "id": "923C101369EE4F45A1A73446BB74F198",
                "priority_level": null
            },
            "components_set": [],
            "accounts_receivable": {
                "number": "ACR0000000025",
                "name": "ACR0000000025 Ramy M",
                "id": "4C13FA60560B42F7939113BD699A9E71",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": null,
                    "last_name": "M",
                    "id": "51DDE9E46B9F4F5EB0E01F909F18FE39",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Ramy",
                    "demographics": {
                        "id_number": "126598",
                        "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,
                        "industry": null,
                        "name_day": {
                            "month": null,
                            "day": null
                        },
                        "passport_number_expiration_date": null,
                        "id_number_expiration_date": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "id": "93506C0DF81C4AF3902BBB07793A85EA"
        },
        {
            "number": null,
            "product": {
                "code": "Caffe Latte",
                "product_type": {
                    "meter_reading_type": null,
                    "service_type": null,
                    "used_for_provisioning": false,
                    "alternative_code": "Z",
                    "udr_type": null,
                    "composition_method": "FLEXIBLEBUNDLE",
                    "name": "Zorbas",
                    "description": null,
                    "id": "A8F22AD71E9C4A818A5CA853E628CA4A",
                    "classification": "PHYSICALGOODS",
                    "physical_good_type": "NONTRACEABLE"
                },
                "alternative_code": "CL",
                "description": "Caffe Latte",
                "id": "847DAF8938094DC7B9542991D0A2916A",
                "priority_level": null
            },
            "components_set": [
                {
                    "product": {
                        "code": "Extra Shot",
                        "product_type": {
                            "meter_reading_type": null,
                            "service_type": null,
                            "used_for_provisioning": false,
                            "alternative_code": "ZC",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Zorbas Component",
                            "description": null,
                            "id": "8EED05CC65A54147B1B6CFD0F80063C4",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "NONTRACEABLE"
                        },
                        "alternative_code": "ES_1",
                        "description": "Extra Shot",
                        "id": "DA6C0E1F5BA34E2EA15B191CAA4FBCDB",
                        "priority_level": null
                    },
                    "id": "639AB6570244472FAA5F9E03A6BEF214"
                }
            ],
            "accounts_receivable": {
                "number": "ACR0000000025",
                "name": "ACR0000000025 Ramy M",
                "id": "4C13FA60560B42F7939113BD699A9E71",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": null,
                    "last_name": "M",
                    "id": "51DDE9E46B9F4F5EB0E01F909F18FE39",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Ramy",
                    "demographics": {
                        "id_number": "126598",
                        "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,
                        "industry": null,
                        "name_day": {
                            "month": null,
                            "day": null
                        },
                        "passport_number_expiration_date": null,
                        "id_number_expiration_date": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "id": "FE6F026B69284100B6E1176521B7B7F3"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Expand

title	Example 2

HTTP Method: GET

Request

Response

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
    "data": [
        {
            "number": "10",
            "product": {
                "code": "TestProduct",
                "product_type": {
                    "meter_reading_type": null,
                    "service_type": null,
                    "used_for_provisioning": false,
                    "alternative_code": "CRM_ProdType",
                    "udr_type": null,
                    "composition_method": "FLAT",
                    "name": "CRM_ProdType",
                    "description": null,
                    "id": "2A102A5FEECB43B2A8778CC4FCECE73C",
                    "classification": "PHYSICALGOODS",
                    "physical_good_type": "TRACEABLE"
                },
                "alternative_code": "TestProduct",
                "description": "TestProduct",
                "id": "757EDF7B9F914096A5AEDF01EA55C679",
                "priority_level": null
            },
            "notes": "Test_2",
            "components_set": [],
            "accounts_receivable": {
                "number": "ACR0000002969",
                "name": "ACR0000002969 Test 16052019_01",
                "id": "207F6A3347244BAC9036CC8B3A1C87B5",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": null,
                    "last_name": "16052019_01",
                    "id": "DAE94BD8C0EB4C63A3A19318F74A5DD9",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Test",
                    "demographics": {
                        "id_number": "16052019_01",
                        "gender": null,
                        "country_of_residence": {
                            "alternative_code": "CYP",
                            "three_character_code": "CYP",
                            "name": "CYPRUS",
                            "id": "181",
                            "two_character_code": "CY"
                        },
                        "date_of_birth": {
                            "month": null,
                            "year": null,
                            "day": null
                        },
                        "industry_sector": null,
                        "industry": null,
                        "name_day": {
                            "month": null,
                            "day": null
                        },
                        "passport_number_expiration_date": null,
                        "id_number_expiration_date": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "id": "B05C26011C3B4D8AA27885B8CD52FFD2"
        },
        {
            "number": "11",
            "product": {
                "code": "10584_01",
                "product_type": {
                    "meter_reading_type": null,
                    "service_type": null,
                    "used_for_provisioning": false,
                    "alternative_code": "CRM_ProdType",
                    "udr_type": null,
                    "composition_method": "FLAT",
                    "name": "CRM_ProdType",
                    "description": null,
                    "id": "2A102A5FEECB43B2A8778CC4FCECE73C",
                    "classification": "PHYSICALGOODS",
                    "physical_good_type": "TRACEABLE"
                },
                "alternative_code": "1_1",
                "description": "Product Description 10584_A01",
                "id": "78E58334893C4ABE8CFAF170856D20C3",
                "priority_level": null
            },
            "notes": "10584_01 for me",
            "components_set": [],
            "accounts_receivable": {
                "number": "ACR0000002969",
                "name": "ACR0000002969 Test 16052019_01",
                "id": "207F6A3347244BAC9036CC8B3A1C87B5",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": null,
                    "last_name": "16052019_01",
                    "id": "DAE94BD8C0EB4C63A3A19318F74A5DD9",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Test",
                    "demographics": {
                        "id_number": "16052019_01",
                        "gender": null,
                        "country_of_residence": {
                            "alternative_code": "CYP",
                            "three_character_code": "CYP",
                            "name": "CYPRUS",
                            "id": "181",
                            "two_character_code": "CY"
                        },
                        "date_of_birth": {
                            "month": null,
                            "year": null,
                            "day": null
                        },
                        "industry_sector": null,
                        "industry": null,
                        "name_day": {
                            "month": null,
                            "day": null
                        },
                        "passport_number_expiration_date": null,
                        "id_number_expiration_date": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "id": "542A111695FC4FBBAD0D9ED2A73B1ED7"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

...

Versions Compared

Old Version 2

New Version Current

Key

Resource URL

Parameters

Restrictions