GET accounts_receivable/configuration/classifications/list

Available from CRM.COM R6.0.0

This method returns the classifications that are allowed to be used in the system, as specified in the active accounts receivable definition. Multiple classifications are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

group_identifier

(optional)

Group Identifier

The identifier of the group that will be providing the classification. The group is filtered against the classifications' allowed organisational units. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be providing the classifications. The unit is filtered against the classifications' allowed organisational units. The allowed unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

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

Response Data

Name	Type	Description
id	String	The id of the retrieved classification
name	String	The name of the retrieved classification
alternative_code	String	The alternative code of the retrieved classification
description	Sting	The description of the retrieved classification
default	Boolean	It determines if the classification is set as the default in the active accounts receivable definition

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "default": true,
            "name": "Account Class1",
            "id": "C44FE706153511DF368C9BCEFBC3AF39",
            "description": "desc",
            "alternative_code": "AC1"
        },
        {
            "default": false,
            "name": "Bad Debtor",
            "id": "57F0EB5645AC9E3D8A622ADE666A57F3",
            "description": "Have History of more than 3 overdue bills",
            "alternative_code": "BD"
        },
        {
            "default": false,
            "name": "Standard Customer",
            "id": "DE3DC5FD43B51C09F7E0573B845ABE08",
            "description": "Standard Customer",
            "alternative_code": "SA"
        },
        {
            "default": false,
            "name": "Premium Customer",
            "id": "3E09F9BCD54109F3F66A91F1E8450109",
            "description": "Premium Customer",
            "alternative_code": "PC"
        },
        {
            "default": false,
            "name": "Employee",
            "id": "428C4DD5F04EE657E7F627D854334694",
            "description": "Employee",
            "alternative_code": "E"
        },
        {
            "default": false,
            "name": "Louciatest",
            "id": "E4E7E76B32DEA28566B934881180290E",
            "description": null,
            "alternative_code": "test"
        },
        {
            "default": false,
            "name": "LuciaTest4",
            "id": "54C07E41E53FABF9706D19785E7FF3DD",
            "description": null,
            "alternative_code": "Lt4"
        },
        {
            "default": false,
            "name": "VIP Customer",
            "id": "DD764F3EB0334FC857F8BE5DD4CB41E1",
            "description": "VIP Customer",
            "alternative_code": "VC"
        }
    ]
}