Versions Compared

Key

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

Table of Contents
outlinetrue
stylenone

...

Cloak
Code Block
languagephp
linenumberstrue
    <equipment>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <glas>
            <item>
                <RECID>1</RECID>
                <NAME>ACCOUNT</NAME>
                <DESCRIPTION>GLA Format for Account Billing Group</DESCRIPTION>
            </item>
        </glas>
    </equipment>
Locations Results
Anchor
locations
locations
Toggle cloak
Cloak
Code Block
languagephp
linenumberstrue
    <equipment>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <locations>
            <item>
                <RECID>261</RECID>
                <TENANTS_RECID>0</TENANTS_RECID>
                <MODIFIED_DATE>2015-01-02 16:47:00</MODIFIED_DATE>
                <MODIFIED_BY>hsolo</MODIFIED_BY>
                <STATUS>1</STATUS>
                <WAREHOUSE_FLAG>0</WAREHOUSE_FLAG>
                <REPORT_911>0</REPORT_911>
                <DEFAULT_WH_LOCATIONS_RECID/>
                <PARENT_LOCATIONS_RECID>7</PARENT_LOCATIONS_RECID>
                <LOCATION_TYPE_LISTS_RECID/>
                <NAME>Tatooine</NAME>
                <BUILDING_NUMBER/>
                <BUILDING_ADDRESSES_RECID/>
                <MASTER_DEFAULT_WAREHOUSE>0</MASTER_DEFAULT_WAREHOUSE>
                <LATITUDE/>
                <LONGITUDE/>
                <DEFAULT_RETURN_WAREHOUSE>0</DEFAULT_RETURN_WAREHOUSE>
                <DEFAULT_RWH_LOCATIONS_RECID/>
                <COMMUNITY_NAME/>
                <L_LOCATION_TYPE_VALUE/>
                <L_LOCATION_TYPE_CODE/>
            </item>
        </locations>
    </equipment>
UDF Results
Anchor
udf
udf
Toggle cloak
Cloak
Code Block
languagephp
linenumberstrue
    <equipment>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <udfs>
            <item>
                <UDF_RECID>10</UDF_RECID>
                <LABEL>test</LABEL>
                <FIELD_TYPE>Text</FIELD_TYPE>
                <REQUIRED>0</REQUIRED>
                <DESCRIPTION>A UDF Field</DESCRIPTION>
                <UDF_ORDER>1</UDF_ORDER>
                <FORM_ELEMENT_WIDTH/>
                <FORM_ELEMENT_HEIGHT/>
                <FORM_ELEMENT_TEXT_WIDTH/>
                <SD_TYPE>Service Request</SD_TYPE>
                <VERIFY>0</VERIFY>
                <AGING_PERSISTENT>0</AGING_PERSISTENT>
                <UDTABLE_DEF/>
                <TYPES/>
            </item>
        </udfs>
    </equipment>

...

Field

Required

Data Type

Options

Default

Notes

recid

no*

Integer



*Conditionally Required if attempting to UPDATE an Equipment Charge

equipment_recid

yes

Integer



The RECID of the Equipment that the Charge is for

charge_recid

yes

Integer

Lists


RECID of the applicable Charge Catalog.

description

no

String



The details or Description of the Charge on the Equipment

amount

no*

FloatDecimal



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.

prorate

no

Integer

1 or 0

0

Should the Charge be prorated when activated

bill_date

no

String



Date the Charge was billed

override_amount

noFloat

Decimal



If allowed by the selected Charge, overrides the default amount from the Charge.

override_gla

no

Integer

Lists


Recid of GLA to override default GLA with.

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

...