GET jobs/configuration/billing_term_schemes/list

Deprecated from CRM.COM R15.0.0

This method returns the billing term schemes that are allowed to be used by a specific type of job. Multiple billing term schemes are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

job_type_identifier

(mandatory)

Job Type Identifier

The identifier of the type of the job that will be using the billing term schemes. The allowed job type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the job type

name

(semi-optional)

String

The name of the job type

alternative_code

(semi-optional)

String

The alternative code of the job type

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 billing term scheme
code	String	The code of the retrieved billing term scheme
name	String	The name of the retrieved billing term scheme
life_cycle_state	String	The life cycle state of the retrieved billing term scheme. The supported life cycle states are the following DRAFT, EFFECTIVE, TERMINATED
classification	String	The classification of the retrieved billing term scheme which can be either SUBSCRIPTIONS or JOBS
billing_type	String	The billing type of the billing term scheme which can be NORMAL or PREPAID
discount_option	String	The discount option of the retrieved billing term scheme that can be FIXED_PRICE or FLEXIBLE_PRICE
description	String	The description of the retrieved billing term scheme
billing_method	String	The billing method of the billing term scheme which can be ANNIVERSARY or PERIOD
concurent_usage_allowed	Boolean	Determines if concurrent usage is allowed for jobs using this billing term scheme Not available from CRM.COM R10.0.0 and onward
requires_prepayment	Boolean	Indicates whether a prepayment is required in order to complete Jobs using this Billing Term Scheme. Available from CRM.COM R13.0.0 and onward
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
log_information	Log Information Object	The log information of the retrieved subscription type

Referred Objects Response Data

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "name": "P Job Billing Term Scheme",
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "id": "9C0B2B52003EFEEE0864212F34D41229",
            "allowed_cycle_day_from": null,
            "billing_method": "PERIOD",
            "classification": "JOBS",
            "requires_prepayment": false,
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "code": "PJBTS",
            "allowed_cycle_day_to": null,
            "log_information":
            {
                "updated_date": "2014-08-07T13:12:45",
                "created_date": "2014-08-07T13:11:55",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "persy",
                    "username": "persy",
                    "id": "3274FDE75239692B81B2526BC1A9E429",
                    "email": "crm.com.tst@gmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "persy",
                    "username": "persy",
                    "id": "3274FDE75239692B81B2526BC1A9E429",
                    "email": "crm.com.tst@gmail.com"
                }
            },
            "discount_option": "FLEXIBLE_PRICE",
            "life_cycle_state": "EFFECTIVE",
            "concurent_usage_allowed": 1,
            "description": "P Job Billing Term Scheme",
            "billing_type": "NORMAL"
        },
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "name": "Jobs Scheme - Concurrent",
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "id": "1B708E843AF1497595A4EE39A1F62ED0",
            "allowed_cycle_day_from": null,
            "billing_method": "PERIOD",
            "classification": "JOBS",
			"requires_prepayment": false,
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "code": "Jobs Scheme - Concurrent",
            "allowed_cycle_day_to": null,
            "log_information":
            {
                "updated_date": "2015-11-05T11:06:51",
                "created_date": "2015-02-26T14:41:50",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "p_xenopoulou",
                    "username": "p_xenopoulou",
                    "id": "159C17D9C4B1E48DC129FBC701D38438",
                    "email": "crm.com.tst@gmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "crm.com.tst@gmail.com"
                }
            },
            "discount_option": "FLEXIBLE_PRICE",
            "life_cycle_state": "TERMINATED",
            "concurent_usage_allowed": 1,
            "description": null,
            "billing_type": "NORMAL"
        },
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "name": "Jobs Scheme - Concurrent",
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "id": "E324F1649CB241788793B96D65F97D9E",
            "allowed_cycle_day_from": null,
            "billing_method": "PERIOD",
            "classification": "JOBS",
            "requires_prepayment": false,
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "code": "Jobs Scheme - Concurrent",
            "allowed_cycle_day_to": null,
            "log_information":
            {
                "updated_date": "2015-11-05T11:06:51",
                "created_date": "2015-11-05T11:06:26",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "p_xenopoulou",
                    "username": "p_xenopoulou",
                    "id": "159C17D9C4B1E48DC129FBC701D38438",
                    "email": "crm.com.tst@gmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "crm.com.tst@gmail.com"
                }
            },
            "discount_option": "FLEXIBLE_PRICE",
            "life_cycle_state": "EFFECTIVE",
            "concurent_usage_allowed": 1,
            "description": null,
            "billing_type": "NORMAL"
        }
    ]
}