Versions Compared

Old Version 3

changes.mady.by.user Brian Dixon

Saved on

compared with

New Version 4

changes.mady.by.user Frank Zerillo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated , to . at end of override_gla description.


Table of Contents
outlinetrue
stylenone

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

status

Active

eqp_catalog

1

billable0
consumed0
use_dhcp0
private0

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

status

Active

eqp_catalog

1

billable0
consumed0
use_dhcp0
private0
equipment_recid

908

vlan1

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

status

Active

eqp_catalog

1

billable0
consumed0
use_dhcp0
private0
equipment_recid

456231

remarksThis is a Remark from the API

...

Field

Required

Data Type

Options

Default

Notes

recid

no*

Integer



*Conditionally Required if attempting to UPDATE an Equipment Charge. RECID column from EQUIPMENT_CHARGES table.

equipment_recid

yes

Integer



The RECID of the Equipment that the Charge is for.

charge_recid

yes

Integer

Value Lookups:

Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


RECID of the applicable Charge Catalog.
description
no
String


The details or Description of the Charge on the Equipment
amount
no*
Decimal


The amount to be charged. *Conditionally Required if charge does not have an amount on it.
quantity
no
Integer

1
Quantity of Charge to be used. Only allowed if Charge Catalog allows it.
prorate
no
Integer
1 or 0
0
Should the Charge be prorated when activated. Only allowed if BILL_MRC_CHANGE_FORCE_PRORATE config option is false
start_datenoString
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_datenoString
MCR
ARC

YYYY-MM-DD format. Other formats may give unexpected results. 
Used for Monthly Recurring Charges and Alternate Recurring Charges
recurring_datenoStringARC
YYYY-MM-DD format. Other formats may give unexpected results. 
Used for Alternate Recurring Charges
transaction_datenoStringNRC
YYYY-MM-DD format. Other formats may give unexpected results. 
Used for Non-Recurring Charges
override_amount
no
Decimal


If allowed by the selected Charge, overrides the default amount from the Charge.
override_gla
no
Integer
Value Lookups:
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


RECID of GLA to override default GLA with. The Override GLA Format should match the Billing Group Format of the Equipment,.
effectivenoStringtoday, backdatetoday
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.
...
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
status
Active
eqp_catalog
1
billable0
consumed0
use_dhcp0
private0
equipment_recid
58337
charge_recid1
...
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
status
Active
eqp_catalog
1
billable0
consumed0
use_dhcp0
private0
equipment_recid
2345
gla1
gla_percent100
gla_typeDefault
...
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
status
Active
eqp_catalog
1
billable0
consumed0
use_dhcp0
private0
equipment_recid
2345
contact1
...
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
status
Active
eqp_catalog
1
billable0
consumed0
use_dhcp0
private0
equipment_recid
765
udf_UDF-RECID1
...