Versions Compared

Key

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

...

Field

Required

Data Type

Options

Default

Notes

type

Yes

String

CHARGES


This is REQUIRED when interacting with GLA Charges

recid

Conditionally*

Integer



*Required if attempting to UPDATE a GLA Charge

gla

Yes

Integer



RECID of the GLA for this Charge

catalog

Yes

Integer

Reading GLAs


Charge Catalog RECID for this Charge

prorate

Yes

Integer

1 or 0

0

1 = Prorate, 0 = Do not Prorate

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

billing_group

No

Integer



RECID of the Billing Group, if applicable

owner_type

No

String

'Contact' or 'Department'


Type of Owner of the Charge

owner

Conditionally

Integer

Contact, Department Hierarchy


RECID of the Owner, *Required if the "owner_type" is provided.

override_amount

No

Decimal



Amount to override the default amount with, if applicable.

stop_datenoString

The Date the Recurring Charge should stop on. YYYY-MM-DD format.
effectivenoStringtoday, backdatetodayEffective flag for the charge being added/stopped. if set to any value other than listed, "today" will be assumed by the API

Results
Toggle cloak

Cloak

...

Cloak

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

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

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

...

Image Modified


Locating GLA Data

Within PCR-360, these menu options list a variety of Grids that can be used to help locate any of the required fields.

...