Versions Compared

Key

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

Available from CRM.COM R14.4.0

Excerpt

This method adds a product in the list of favorite items. A single product can be added on each call

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts Receivable Identifier

The accounts receivable owning the list of favorite items. The available accounts receivable identifiers are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

item

(mandatory)

Favorite Item ObjectThe item that will be added in the list of favorite items

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: POST


Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
	"token": {{token}},
	"accounts_receivable_identifier": {
		"number": "ACR0000000025"
	},
	"item": {
		"product_identifier": {
			"code": "123"
		}
	}
}



Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "data": {
        "number": null,
        "product": {
            "code": "123",
            "product_type": {
                "meter_reading_type": null,
                "service_type": null,
                "used_for_provisioning": true,
                "alternative_code": "STB",
                "udr_type": null,
                "composition_method": "FLAT",
                "name": "SET TOP BOX",
                "description": "SET TOP BOX",
                "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                "classification": "PHYSICALGOODS",
                "physical_good_type": "TRACEABLE"
            },
            "alternative_code": "1_13",
            "description": "desc",
            "id": "99E46901A95B4E31A60BBE67280F2522",
            "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": {
                    "name_day": {
                        "month": null,
                        "day": null
                    },
                    "id_number": "126598",
                    "passport_number_expiration_date": null,
                    "gender": null,
                    "date_of_birth": {
                        "month": null,
                        "year": null,
                        "day": null
                    },
                    "id_number_expiration_date": null,
                    "industry_sector": null,
                    "passport_number": null,
                    "industry": null,
                    "social_security_number": null,
                    "id_issued_by_country": null,
                    "passport_issued_by_country": null
                }
            }
        },
        "id": "5AB3DB960C724D7C8AD5929E493101B9"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}