Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Health Check: The link has been rewritten to its master page by check 'P16'.

...

Field

Required

Data Type

Options

Default

Notes

RECID

only when updating

Integer



Identifier of the record to be updated

due_date

no

String



The date when the service desk item is due.

type

yes

String

"SO" - Service Order
"IN" - Incident
"ES" - Estimate


Service desk type

source

no

String


"API"

Source of the service desk item

urgency

no

String

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


Set the urgency on the Service Desk Item.

csr

yes

Integer

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


The customer service representative assigned to the service desk item. The Record ID of the service rep to be assigned is a required field.

owner

no*

Integer

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


Record ID of either the Contact or the Department owner.
*Required only when completing an order

owner_type

no*

String

"contact" or "department"


Type of owner.
*Required only when setting an owner

requestor

no

Integer

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


Record ID for the name of the person (contact) who is requesting the service desk item.

description

no

String



A description of the service desk item

assoc_proj

no

Integer



Record ID of the project or problem associated with the service desk item.

remarks

no

String



Service Desk remarks. These remarks show up on the "Activity/Remarks" tab of Service Desk.

udf_IDENTIFIER

no

mixed

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


IDENTIFIER of UDF preceded by “udf_”. Example: udf_FIELD123
Provided value will be validated against UDF’s data type requirements and used if acceptable.

...

Field

Required

Data Type

Options

Default

Notes

prob_code

no

Integer

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


Record ID of the trouble code.

problem

no

String



The details or description of the trouble

res_code

no

Integer

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


Record ID of the resolution code.

resolution

no

String



The details or description of the resolution

service

no

Integer



Record ID for the service with the trouble

equipment

no

Integer



Record ID for the equipment with the trouble

...

Field

Required

Data Type

Options

Default

Notes

charge_catalog

no

Integer

Lists


Record ID of the applicable charge.

charge_description

no

String



The details or description of the charge on the estimate

chrg_quantity

no

Integer


1

Quantity of charge to be used.

prorate

no

Integer

1 or 0

0

Should the charge be prorated when activated

override_amount

no

Float



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

eqp_catalog

no

Integer

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


Record ID of the equipment catalog item to added to the estimate.

eqp_quantity

no

Integer


1

Quantity of the equipment to be added to the estimate.

eqp_billable

no

Integer

1 or 0


Mark whether the equipment item is billable.

labor_type

yes*

Integer

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


Type of labor to be added.
*Only required when adding labor to the estimate (when "workgroup" field is provided).

workgroup

no

Integer

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


Record ID of the workgroup to be associated with the labor record on the estimate.

labor_description

no

String



Description to give the labor record.

hours

yes*

String



Hours to be assigned to the labor. Use "h" for hours and "m" for minutes. Example: "1h 30m"
*Only required when adding labor to the estimate (when "workgroup" field is provided).

rate

no

Float



Rate to be billed for labor. If not provided, default rate from Workgroup will be used.

labor_billable

no

Integer

1 or 0


Mark whether the labor item is billable.

...

Field

Required

Data Type

Options

Default

Notes

estimate_recid

yes

Integer



The RECID of the Service Desk Estimate that the charge is for

charge_catalog

yes

Integer

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


Record ID of the applicable charge.

charge_description

no

String



The details or description of the charge on the estimate

chrg_quantity

no

Integer


1

Quantity of charge to be used.

prorate

no

Integer

1 or 0

0

Should the charge be prorated when activated

override_amount

no

Float



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

...

Field

Required

Data Type

Options

Default

Notes

estimate_recid

yes

Integer



The RECID of the Service Desk Estimate that the charge is for

labor_type

yes

Integer

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


Type of labor to be added.

workgroup

yes

Integer

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


Record ID of the workgroup to be associated with the labor record on the estimate.

labor_description

no

String



Description to give the labor record.

hours

yes

String



Hours to be assigned to the labor. Use "h" for hours and "m" for minutes. Example: "1h 30m".

rate

no

Float



Rate to be billed for labor. If not provided, default rate from Workgroup will be used.

labor_billable

no

Integer

1 or 0


Mark whether the labor item is billable.

...

Field

Required

Data Type

Options

Default

Notes

estimate_recid

yes

Integer



The RECID of the Service Desk Estimate that the charge is for

eqp_catalog

yes

Integer

.Service Desk API Calls v2.1.4.7#ListsCalls#Lists


Record ID of the equipment catalog item to added to the estimate.

eqp_quantity

yes

Integer


1

Quantity of the equipment to be added to the estimate.

eqp_billable

yes

Integer

1 or 0


Mark whether the equipment item is billable.

...