Page Comparison

...

Type

Description

Extra Parameters*

Searchable

Results

CHARGE_CATALOG

Get available Charge Catalogs

Yes

Charger Catalog Results

Toggle cloak

Cloak

Code Block

language	js

{
        status: success,
        page: 1,
        count: 64,
        total_count: 64,
        charge_catalog: [
            {
                RECID: 167,
                NAME: Starship Detailing,
                DESCRIPTION: 1-time charge for cleaning of starships,
                AMOUNT: 126587,
                CHARGE_TYPE_LISTS_RECID: 1981,
                EXPENSE_TYPE_LISTS_RECID: 1182,
                PARENT_CHRG_CATALOG_RECID: ‘’,
                REVENUE_GLA_RECID: 1,
                USE_QUANTITY: 1,
                TAXABLE: 0,
                ALLOW_OVERRIDE: 1,
                CC_CHARGE_TYPE_VALUE: 1 time,
                CC_CHARGE_TYPE_CODE: 1_TIME,
                CC_EXPENSE_TYPE_VALUE: Default,
                CC_EXPENSE_TYPE_CODE: DEFAULT,
            },
	    {…}
       ]
}

CONTACTS

Get available Contacts

CTYPE - Type of contact. Example: "worker"

Yes

Contacts Results

Toggle cloak

Cloak

Code Block

language	js

{
        status: success,
        page: 1,
        count: 20,
        total_count: 20,
        contacts: [
            {
                RECID: 809,
                SERVICE_REP: Doe, John,
                STATUS: 1,
                CONTACT_TYPE_LISTS_RECID: 1147,
                C_TITLE_VALUE: null,
                C_TITLE_CODE: null,
                CTYPE_CONTACT_TYPE_VALUE: User,
                CTYPE_CONTACT_TYPE_CODE: USER
            },
            {…}
        ]
}

DEPTHIER

Get available Departments

No

Departmental Hierarchy Results

Toggle cloak

Cloak

Code Block

language	js

{
        status: success,
        page: 1,
        count: 20,
        total_count: 20,
        depthier: [
            {
                RECID: 24,
                DH_NAME: Facilities,
                STATUS: 1,
                DEFAULT_SLA_DESC: null,
                DEFAULT_INCI_SLA_DESC: null,
                BG_NAME: Admin,
                DEPT_HIERARCHY_PATH: FM,
                DEPT_HIERARCHY_PATH_TOOLTIP: FM,
                NAME_AND_BG: FM – Admin
            },
            {…}
        ]
}

...

*Postscript note: The value ‘gla_item_n’ represents any additional GLA Components a specific installation may have where 'n' is a sequential number starting at 2 and incrementing by 1 for each additional GLA Component. The necessity to provide each additional Component also depends on your installation of PCR-360. If Users have any questions about how many GLA Components their system has and if the Components are Required, please contact your System Administrator.

Results

Toggle cloak

Cloak

If the request is successful, the RECID of the GLA will be returned as follows:

Code Block

language	js

{
    Status: success,
    page: 1,
    count: 1,
    total_count: 1,
    gla: 58337
}

In the above example, '58337' represents the returned RECID.

...

Field	Required	Data Type	Options	Default	Notes
type	Yes	String	CHARGES		This is Required when interacting with GLA Charges
recid	No*	Integer			*Conditionally Required if attempting to UPDATE a GLA Charge. RECID column from GLA_CHARGES table.
gla	Yes	Integer			RECID of the GLA for this Charge.
charge_catalog_recid	Yes	Integer	Reading GLAs		Charge Catalog RECID for this Charge.
prorate	No	Integer	1 or 0	0	1 = Prorate, 0 = Do not Prorate. Only allowed if BILL_MRC_CHANGE_FORCE_PRORATE config option is false.
description	No	String			Description of the Charge.
amount	No	Decimal			Will be used if Charge Catalog does not have a Default Amount set.
quantity	No	Integer			The quantity of Charge to be applied. Only allowed if Charge Catalog allows it.
start_date	No	String	MRC ARC		The Start Date of a Charge. YYYY-MM-DD format. Other formats may give unexpected results. Used for Monthly Recurring Charges and Alternate Recurring Charges.
stop_date	No	String	MRC ARC		YYYY-MM-DD format. Other formats may give unexpected results. Used for Monthly Recurring Charges and Alternate Recurring Charges.
recurring_date	No	String	ARC		YYYY-MM-DD format. Other formats may give unexpected results. Used for Alternate Recurring Charges.
transaction_date	No	String	NRC		YYYY-MM-DD format. Other formats may give unexpected results. Used for Non-Recurring Charges.
billing_group	No	Integer			RECID of the Billing Group, if applicable.
owner_type	Yes	String	'Contact' or 'Department'		Type of Owner of the Charge.
owner	Yes	Integer	Contact, Department Hierarchy		RECID of the Owner.
override_amount	No	Decimal			Amount to override the default amount with, if applicable.
effective	No	String	today, backdate	today	Effective flag for the charge being added/stopped. if set to any value other than listed, "today" will be assumed by the API. Alternate Recurring Charges (Quarterly, Semi-Annual, and Annual), when updated will always use backdate as the Effective Date.

...

Charge Catalog restrictions are not violated
Error if the amount is provided and the Catalog does not allow overrides
Error if quantity provided for non/quantity Catalogs, also checks for whole numbers/fractional and errors is a fraction
Verify Service is billable when adding a Charge
Verify there exists an expense GLA that matches the Charge Catalog Expense Type
Monthly Recurring Charges
- start_date is required for new charge
- error if stop_date is provided for billing complete charges
- error if stop_date is earlier than start_date
Non-Recurrring Charges
- transaction_date is required for new charge
- error if stop_date is provided
Alternate Recurring Charges (Annual, Semi-Anual, Quarterly)
- start_date is required for new charge
- recurring_date is required for new charge
- error if stop_date is provided for billing complete charges

Results

Toggle cloak

Cloak

If the request is successful, the RECID of the GLA Charge will be returned as follows:

Code Block

language	js

{
    status: success,
    page: 1,
    count: 1,
    total_count: 1,
    gla: 2342
}

In the above example, '2342' represents the returned RECID.

...

Versions Compared

Old Version 1

New Version 2

Key

Results

Results