POST accounts_receivable/favorite_items/remove

Available from CRM.COM R14.4.0

This method removes a product from the list of favorite items. A single product can be removed on each call

Resource URL

Parameters

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

favorite_item_identifier

(mandatory)

Favorite Item Identifier

The favorite item that will be removed from the list of favorite items. The available favorite item identifiers are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the favorite item

number

(semi-optional)

 

String

The number of the favorite item

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.

Response Data

N/A

Examples

 Example 1

HTTP Method: POST


Request:

Body:

 {
	"token": {{token}},
	"accounts_receivable_identifier": {
		"number": "ACR0000000025"
	},
	"favorite_item_identifier": {
		"id": "93506C0DF81C4AF3902BBB07793A85EA"
	}
}



Response:

 {
    "data": {},
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}