Page Comparison

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

'Contactcontact' or 'Departmentdepartment'

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.