CommonSuspenseInsertRequest Complex Type

In This Topic

Description

Request object containing the suspense data to be inserted into the database.

Namespace

https://wsapi.ams360.com/v3.0/DataContract

Diagram

Overview

CommonSuspenseInsertRequest

Request object containing the suspense data to be inserted into the database.

Sequence

CommonSuspense optional CommonSuspense Complex Type

Single Suspense type data structure.

Sequence

SuspenseId optional guid Simple Type

Globally Unique Identifier (GUID) for a suspense.

Insert Validation:
AMS360 creates on insert. If provided in web method, the value is ignored

Update Validation:
Required for update.

36 character alpha-numeric column formatted as: 00000000-0000-0000-0000-000000000000. For Updates, The suspense must exist, and the AMS360 user associated with the logged-in WSAPI user must have access to the customer suspense.

SuspenseTypeId optional xs:string

Entity code of the entity this suspense is attached to.

Must be a valid code for the entity specified by the SuspenseType

SuspenseType optional xs:short

Value representing the type of entity (bank, broker, company, employee, or vendor) this suspense is attached to.

Code value from the "SuspenseCenter" value list.

If you know the name of a value list and only need the contents of the list, you can retrieve the list using the GetValueList() method.

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=SuspenseCenter

SuspenseAction optional xs:string

Describes the action taken that the suspense is written for.

Insert Validation:
Must be a valid value from the ActivityAction list.

Description value from the "ActivityAction" value list.

Method=ValueListGet()
InputType=ValueListGetRequest
ListName=ActivityAction

InitiatedDate optional xs:dateTime

The date the suspense was initially created. Set automatically on insert by AMS360.

Insert Validation:
Not available on insert. This value is ignored and no error message is returned.

Update Validation:
Not available on update. This value is ignored and no error message is returned.

InitiatedByEmployeeCode optional xs:string

Employee code of the person who created the suspense. Set automatically on insert by AMS360.

Insert Validation:
Not available on insert. This value is ignored and no error message is returned.

Update Validation:
Not available on update. This value is ignored and no error message is returned.

AssignedToEmployeeCode optional xs:string

Employee code of the person to whom the suspense is assigned.

DueDate optional xs:dateTime

The due date of the suspense.

Insert Validation:
Must not be prior to the current date.

Update Validation:
Must not be prior to the current date.

TimesRescheduled optional xs:unsignedByte

Incremented each time the suspense is updated and the DueDate field is changed. Calculated automatically on insert by AMS360.

Insert Validation:
Not available on insert. This value is ignored and no error message is returned.

Update Validation:
Not available on update. This value is ignored and no error message is returned.

Description optional xs:string

Suspense text to be inserted.

Priority optional xs:short

Priority level for the suspense.

Valid values are:
1 = Critical
5 = Normal
10 = Low

IsCompleted optional xs:boolean

Flag indicating whether the suspense is complete or not.

CompletedBy optional xs:string

Employee code of the person who completed the suspense. Value set or cleared automatically on update of the suspense by AMS360 based on the IsCompleted value.

Insert Validation:
Not available on insert. This value is ignored and no error message is returned.

Update Validation:
Not available on update. This value is ignored and no error message is returned.

CompletedDate optional xs:dateTime

Date that the suspense was completed. Will be null for uncompleted suspense. Value set or cleared automatically on update of the suspense by AMS360 based on the IsCompleted value.

Insert Validation:
Not available on insert. This value is ignored and no error message is returned.

Update Validation:
Not available on update. This value is ignored and no error message is returned.

Used By

Request Element
CommonSuspenseInsertRequest Element

Source

<xs:complexType name="CommonSuspenseInsertRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:appinfo />
    <xs:documentation>
      <summary>
            Request object containing the suspense data to be inserted into the database.
            </summary>
    </xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element minOccurs="0" name="CommonSuspense" nillable="true" type="tns:CommonSuspense">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Single Suspense type data structure.
            </summary>
          <required />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>