PwsCompanyRef

Overview


This structure is used to uniquely identify a company. Companies can be identified by CompanyName, CompanyUid or CompanyNumber. When specifying a PwsCompanyRef as an input to a web service, you may specify one, two or all three fields, CompanyName, CompanyUid or CompanyNumber. However, if you do specify more than one field, all specified values must refer to the same company or the company reference will not be considered valid. When a PwsCompanyRef is returned in the response to a web service, the CompanyName, CompanyUid and CompanyNumber will be populated, and guaranteed to refer to a single company.

Format


PwsCompanyRef
  • PwsCompanyRef
    • CompanyId: Int32
    • CompanyName: String (50)
    • CompanyUid: Int64 (20)
    • CompanyNumber: String

Elements


Element

Data Type

Required?

Description

Sample Data

CompanyId

Int32

No

The company Id is a unique identifier for a company. For internal use only.


CompanyName

String (50)

One of CompanyName, CompanyUid or CompanyNumber is required

The company name is a unique identifier for a company.

USA

CompanyUid

Int64

See CompanyName

The company Uid is a unique and immutable identifier for a company.

1152921504606850739

CompanyNumber

String (20)

See CompanyName

The company number is a unique identifier for a company.

USA

Usage Example(s)

Example 01
                  <b:CompanyIdentity>
                     <b:CompanyId i:nil="true"/>
                     <b:CompanyName>USA</b:CompanyName>
                     <b:CompanyUid>1152921504606850739</b:CompanyUid>
                     <b:CompanyNumber>USA</b:CompanyNumber>
                  </b:CompanyIdentity>