This specifies the fields associated with a client record.
| Element | Data Type | Description | Default (on insert/update) | Sample Data |
|---|
| ClientId | Int32 | Client Id. For internal use only. |
|
|
| ClientNumber | String | The client number is a unique identifier for a client. |
| Client-001 |
| ClientUid | Int64 | The client UID is a unique and immutable identifier for a client |
| 1152921504606961482 |
| ClientName | String | The client name is a unique identifier for a client. |
| Acme 123 |
| InactiveFlag | Boolean | Valid values for this field include "true" or false". If "true" the client has a status of "Inactive", if "false" the client has a status of "Active" |
| false |
| ParentClientIdentity | PwsClientRef | Parent client identity associated with the client |
|
|
Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 - Client without parent |
|---|
| collapse | true |
|---|
|
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>Projector PSA</ClientNumber>
<ClientUid>1152921504606961482</ClientUid>
<ClientName>Projector PSA</ClientName>
<InactiveFlag>false</InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
|
| Code Block |
|---|
| language | xml |
|---|
| title | Example 02 - Client with parent |
|---|
| collapse | true |
|---|
|
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>C001000</ClientNumber>
<ClientUid>1152921504606989813</ClientUid>
<ClientName>Acme 1000-01</ClientName>
<InactiveFlag>false</InactiveFlag>
<ParentClientIdentity>
<ClientId i:nil="true"/>
<ClientNumber>C000118</ClientNumber>
<ClientUid>1152921504606989807</ClientUid>
</ParentClientIdentity>
</PwsClientSummary>
|