Page Comparison

RECID

only when updating

Integer

Identifier of the record to be updated

status

yes

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

The status of the service.

serv_catalog

yes

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

Recid of the Service Catalog item.

service_id

yes

String

Service ID of this service

service_id_fmt

no

String

Formatted version of the Service ID

owner

no*

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

Record ID of either the Contact or the Department owner.

owner_type

no*

String

"contact" or "department"

Type of owner

location

no

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

Recid of location for service.

service_host

no

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

Recid of Service Host for service.

sla

no

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

Recid of SLA for service.

reference

no

String

Reference for service

billable

no

Integer

1 = yes; 0 = no

Designate if the Service is Billable

billing_group

no

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

Recid of billing group for service.

essential

no

Integer

1 = yes; 0 = no

Designate if this is an essential Service

status_date

yes

String

Date status was set for Service

assoc_service

no

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

Recid of Associated Service.

equipment

no

String

.Services API Calls v2.1.4.7#ListsCalls#Lists

Recid(s) of equipment to add to Service. If multiple Equipment are to be assigned, separate Recids with commas. Example: 56,875.

contact

no

String

.Services API Calls v2.1.4.7#ListsCalls#Lists

Recid(s) of Contacts to add to Service. If multiple contacts are to be assigned, separate recids with commas. Example: 1234,7894.

remarks

no

String

Remarks to add to the Service

pool

no

String

.Services API Calls v2.1.4.7#ListsCalls#Lists

Recids of Service pool(s) to add to the Service. If multiple contacts are to be assigned, separate recids with commas. Example: 548,785.

gla

no

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

Recid(s) of GLA record(s) to assign to this service. If multiple GLAs are to be assigned, separate recids with commas. Example: 874,32.

gla_percent

no*

String

100

Percentage(s) of this Service that should apply to specified GLA(s). *If multiple GLAs are provided, then percent is required and the same count of percentages need to be provided also. Total of all percentages must equal exactly 100.

gla_type

no*

String

.Services API Calls v2.1.4.7#ListsCalls#Lists

List Value(s) of Expense Type(s). *Required if GLA is specified.

service_type

yes

String

"phone", "data", "authcode", "backbone"

Type of Service. This value determines specific fields and requirements listed below.

directory

yes

Integer

1 = yes; 0 = no

IF service_type = "phone". Designates if this Service is to be listed in the directory.

report_911

yes

Integer

1 = yes; 0 = no

IF service_type = "phone". Designates if this Service is to be listed in emergency 911 feed.

multiple_locations

no

Integer

1 = yes; 0 = no

IF service_type = "phone". Designates if this Service has multiple locations.

bandwidth

no

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

IF service_type = "data" OR "backbone". Recid of bandwidth record.

auth_code_type

no

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

IF service_type = "authcode". Recid of authcode type.

service_class

no

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

IF service_type = "authcode". Recid of Service Class for authcode.

service_recid

yes

Integer

The RECID of the Service that the charge is for

charge_recid

yes

Integer

Record ID of the applicable charge catalog. See .Services API Calls v2.1.4.7#ListsCalls#Lists about how to retrieve available Charge Catalogs.

description

no

String

The details or description of the charge on the Equipment

amount

no*

Float

The amount to be charged. *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

gla

no

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

Recid of GLA to assign to Service Charge

location

no

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

Location that this Charge applies to for the service

service_recid

yes

Integer

The RECID of the Service that the GLA is for

gla

yes

String

Lists

Record ID(s) of the applicable GLA(s).

gla_percent

yes

String

Percentages to apply to each GLA. All percentages must equal exactly 100.

gla_type

yes

String

.Services API Calls v2.1.4.7#ListsCalls#Lists

The type(s) of GLA(s).

service_recid

yes

Integer

The RECID of the Service that the contact is for

contact

yes

String

.Services API Calls v2.1.4.7#ListsCalls#Lists

Record ID(s) of the contact(s).

service_recid

yes

Integer

Recid of service

location

yes

Integer

.Services API Calls v2.1.4.7#ListsCalls#Lists

Recid(s) of the location(s) to assign to the service.

report_911

yes

Integer

1 = yes; 0 = no

Designate if Location should show on emergency 911 feed

location_status

yes

Integer

1 = yes; 0 = no

Status of location

service_recid

yes

Integer

Recid of service

equipment

yes

String

.Services API Calls v2.1.4.7#ListsCalls#Lists

Recid(s) of Equipment to assign to the Service