Vendor Complex Type

In This Topic

Description

Data structure for a single vendor entity when retrieving vendor data.

Namespace

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

Diagram

Overview

Vendor

Data structure for a single vendor entity when retrieving vendor data.

Sequence

Description optional xs:string

Text that will default into the description field on creating receipts, journal entries and the for field on creating checks. Entered and maintained by the agency.

EmployerIdentificationNumber optional xs:string

Vendor's tax identification number. Entered and maintained by the agency.

FirstName optional xs:string

Vendor's first name. If the vendor is a firm, this field does not apply and the value is null.

GLNumber optional xs:string

Unique identifier for a general ledger account number.

IsCompany optional xs:boolean

Flag indicating whether the vendor is a firm (true) or individual (false).

IsInactive optional xs:boolean

Flag indicating whether the vendor is active (false) or inactive (true).

LastName optional xs:string

Vendor's last name. If the vendor is a firm rather than an individual, this represents the firm name.

MiddleName optional xs:string

Vendor's middle name. If the vendor is a firm, this field does not apply and the value is null.

ShortName optional xs:string

Unique identifier for a vendor. This displayable code is entered and maintained by the agency.

VendorCode optional xs:string

Unique identifier for a vendor.

Uniqueness is maintained in AMS360.

Used By

Vendor Element
Vendor Element

Source

<xs:complexType name="Vendor" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:appinfo />
    <xs:documentation>
      <summary>
            Data structure for a single vendor entity when retrieving vendor data.
            </summary>
    </xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Text that will default into the description field on creating receipts, journal entries and the for field on creating checks. Entered and maintained by the agency.
            </summary>
          <len min="0" max="52" />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="EmployerIdentificationNumber" nillable="true" type="xs:string">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Vendor's tax identification number. Entered and maintained by the agency.
            </summary>
          <len min="0" max="15" />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="FirstName" nillable="true" type="xs:string">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Vendor's first name. If the vendor is a firm, this field does not apply and the value is null.
            </summary>
          <len min="0" max="16" />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="GLNumber" nillable="true" type="xs:string">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Unique identifier for a general ledger account number.
            </summary>
          <len min="0" max="8" />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="IsCompany" type="xs:boolean">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Flag indicating whether the vendor is a firm (true) or individual (false).
            </summary>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="IsInactive" type="xs:boolean">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Flag indicating whether the vendor is active (false) or inactive (true).
            </summary>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="LastName" nillable="true" type="xs:string">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Vendor's last name. If the vendor is a firm rather than an individual, this represents the firm name.
            </summary>
          <len min="0" max="51" />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="MiddleName" nillable="true" type="xs:string">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Vendor's middle name. If the vendor is a firm, this field does not apply and the value is null.
            </summary>
          <len min="0" max="11" />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="ShortName" nillable="true" type="xs:string">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Unique identifier for a vendor. This displayable code is entered and maintained by the agency.
            </summary>
          <len min="0" max="6" />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="VendorCode" nillable="true" type="xs:string">
      <xs:annotation>
        <xs:appinfo />
        <xs:documentation>
          <summary>
            Unique identifier for a vendor.
            </summary>
          <len min="3" max="3" />
          <values>
            Uniqueness is maintained in AMS360.
            </values>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>