Versions Compared

Old Version 7

changes.mady.by.user Bettina Borces

Saved on

compared with

New Version Current

changes.mady.by.user Luke Wright

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This structure contains the complete set of information about a client (less any subordinate entities). The structure is used both to retrieve detailed Client information and to pass information about a Client back to the server to get updated.

Format

...

is returned by services such as PwsGetClient, which return the full details about clients. This structure contains a client detail structure (PwsClientDetail). It is also where additional related information about the client, that is not directly an attribute of the client itself would be found. As of this time, there is no additional information returned about clients.

Format


Panel
titlePwsClientElement

Elements


Element

Data Type

Required?

Description

Sample Data

ClientDetail

PwsClientDetail

Yes

The complete set of information about a client (less any subordinate entities).


Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<PwsClientElement>
   <ClientDetail>                <b:PwsClientElement>
                  <b:ClientDetail>
                     <b:ClientId i:nil="true"/>
                     <b:ClientNumber>C000121</b:ClientNumber>
                     <b:ClientUid>1152921504606998462</b:ClientUid>
                     <b:ClientName>Parent Inc.</b:ClientName>
                     <b:InactiveFlag>false</b:InactiveFlag>
                     <b:ParentClientIdentity i:nil="true"/>
                     <b:Address>
                        <b:AddressLine1>100 Main Street</b:AddressLine1>
                        <b:AddressLine2 i:nil="true"/>
                        <b:Attention>Finance</b:Attention>
                        <b:City>Boston</b:City>
                        <b:CompanyName>Acme 1000</b:CompanyName>
                        <b:Country>USA</b:Country>
                        <b:StateOrProvince>MA</b:StateOrProvince>
                        <b:ZipOrPostalCode>02114</b:ZipOrPostalCode>
                     </b:Address>
                     <b:BillingCycleIdentity>
                        <b:BillingCycleId i:nil="true"/>
                        <b:BillingCycleName>Monthly</b:BillingCycleName>
                        <b:BillingCycleUid>1152921504606853180</b:BillingCycleUid>
                     </b:BillingCycleIdentity>
                     <b:BillingInstructions>Please bill this client at the end of each month.</b:BillingInstructions>
                     <b:ClientMessage>We appreciate your business!</b:ClientMessage>
                     <b:ClientMessagePlain>We appreciate your business!</b:ClientMessagePlain>
                     <b:InheritAddressFlag>false</b:InheritAddressFlag>
                     <b:InheritBillingCycleFlag>false</b:InheritBillingCycleFlag>
                     <b:InheritBillingInstructionsFlag>false</b:InheritBillingInstructionsFlag>
                     <b:InheritClientMessageFlag>false</b:InheritClientMessageFlag>
                     <b:InheritInvoiceContentFlag>false</b:InheritInvoiceContentFlag>
                     <b:InheritInvoiceScopeFlag>false</b:InheritInvoiceScopeFlag>
                     <b:InheritInvoiceTemplateFlag>false</b:InheritInvoiceTemplateFlag>
                     <b:InheritPaymentTermFlag>false</b:InheritPaymentTermFlag>
                     <b:InheritPurchaseOrderNumberFlag>false</b:InheritPurchaseOrderNumberFlag>
                     <b:InheritStandardRatesFlag>false</b:InheritStandardRatesFlag>
                     <b:InheritTimeBillingTypeFlag>false</b:InheritTimeBillingTypeFlag>
                     <b:InvoiceContent>B</b:InvoiceContent>
                     <b:InvoiceScope>E</b:InvoiceScope>
                     <b:InvoiceTemplateIdentity>
                        <b:InvoiceTemplateId i:nil="true"/>
                        <b:InvoiceTemplateName>A100</b:InvoiceTemplateName>
                        <b:InvoiceTemplateUid>1152921504606878901</b:InvoiceTemplateUid>
                     </b:InvoiceTemplateIdentity>
                     <b:NewClientNumber i:nil="true"/>
                     <b:PaymentTermIdentity>
                        <b:PaymentTermId i:nil="true"/>
                        <b:PaymentTermName>Net 30</b:PaymentTermName>
                        <b:PaymentTermUid>1152921504606856054</b:PaymentTermUid>
                     </b:PaymentTermIdentity>
                     <b:PurchaseOrderNumber>P-001</b:PurchaseOrderNumber>
                     <b:StandardBillingAdjustedDiscountPercent>5</b:StandardBillingAdjustedDiscountPercent>
                     <b:StandardContractDiscountPercent>10</b:StandardContractDiscountPercent>
                     <b:StandardRateCardIdentity>
                        <b:RateCardId i:nil="true"/>
                        <b:RateCardName>USA Rate Card</b:RateCardName>
                        <b:RateCardType>R</b:RateCardType>
                        <b:RateCardUid>1152921504606860819</b:RateCardUid>
                     </b:StandardRateCardIdentity>
                     <b:TimeBillingType>H</b:TimeBillingType>
                     <b:Timestamp>AAAAAA97WG8=</b:Timestamp>
                     <b:UserDefinedFields>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>CL-Date</b:UdfName>
                           <b:UdfUid>1152921504606856792</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>D</b:DataType>
                           <b:DateValue>2018-01-17T00:00:00Z</b:DateValue>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>CL-Integer</b:UdfName>
                           <b:UdfUid>1152921504606856793</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>I</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue>10</b:IntegerValue>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue>10</b:NumericValue>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>CL-Resource</b:UdfName>
                           <b:UdfUid>1152921504606856794</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>R</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue>
                              <b:ResourceDisplayName>John Doe</b:ResourceDisplayName>
                              <b:ResourceId i:nil="true"/>
                              <b:ResourceReferenceSystemId>E123</b:ResourceReferenceSystemId>
                              <b:ResourceUid>1152921504607062225</b:ResourceUid>
                           </b:ResourceIdentityValue>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>CL-Text</b:UdfName>
                           <b:UdfUid>1152921504606856795</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>T</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>Parent Client</b:TextValue>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>CL-Text List</b:UdfName>
                           <b:UdfUid>1152921504606856796</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>L</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>CL-1A</b:TextValue>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>CL-Boolean</b:UdfName>
                          <ClientId i:nil="true"/><b:UdfUid>1152921504606856797</b:UdfUid>
      <ClientNumber>C000117</ClientNumber>       <ClientUid>1152921504606989806</ClientUid>       <ClientName>Projector PSA</ClientName>       <InactiveFlag>false</InactiveFlag><b:BooleanValue>true</b:BooleanValue>
       <ParentClientIdentity i:nil="true"/>       <Address>          <AddressLine1>85 Merrimac Street</AddressLine1>
<b:DataType>Y</b:DataType>
        <AddressLine2>Suite 200</AddressLine2>          <Attention>Finance</Attention>          <City>Boston</City><b:DateValue i:nil="true"/>
         <CompanyName>Acme 123</CompanyName>          <Country>MA</Country>          <StateOrProvince>MA</StateOrProvince><b:IntegerValue i:nil="true"/>
         <ZipOrPostalCode>02114</ZipOrPostalCode>       </Address>       <BillingCycleIdentity>          <BillingCycleId <b:ResourceIdentityValue i:nil="true"/>
         <BillingCycleName>Monthly</BillingCycleName>          <BillingCycleUid>1152921504606853180</BillingCycleUid>       </BillingCycleIdentity>   <b:TextValue i:nil="true"/>
   <BillingInstructions>This client should be billed on the 15th of every month</BillingInstructions>       <ClientMessage>We appreciate your business!</ClientMessage>       <ClientMessagePlain>We appreciate your business!</ClientMessagePlain> <b:UdfTreatment>A</b:UdfTreatment>
      <InheritAddressFlag>false</InheritAddressFlag>       <InheritBillingCycleFlag>false</InheritBillingCycleFlag>       <InheritBillingInstructionsFlag>false</InheritBillingInstructionsFlag>       <InheritClientMessageFlag>false</InheritClientMessageFlag><b:StoplightValues/>
       <InheritInvoiceContentFlag>false</InheritInvoiceContentFlag>       <InheritInvoiceScopeFlag>false</InheritInvoiceScopeFlag>       <InheritInvoiceTemplateFlag>false</InheritInvoiceTemplateFlag>       <InheritPaymentTermFlag>false</InheritPaymentTermFlag><b:NumericValue i:nil="true"/>
        <InheritPurchaseOrderNumberFlag>false</InheritPurchaseOrderNumberFlag>       <InheritStandardRatesFlag>true</InheritStandardRatesFlag>       <InheritTimeBillingTypeFlag>false</InheritTimeBillingTypeFlag>       <InvoiceContent>B</InvoiceContent><b:RelationValue i:nil="true"/>
      <InvoiceScope>E</InvoiceScope>       <InvoiceTemplateIdentity>          <InvoiceTemplateId i:nil="true"/></b:PwsUserDefinedFieldDetail>
          <InvoiceTemplateName>A100</InvoiceTemplateName>          <InvoiceTemplateUid>1152921504606878901</InvoiceTemplateUid>    <b:PwsUserDefinedFieldDetail>
  </InvoiceTemplateIdentity>       <NewClientNumber i:nil="true"/>       <PaymentTermIdentity>          <PaymentTermId<b:UdfId i:nil="true"/>
         <PaymentTermName>Net 15</PaymentTermName>          <PaymentTermUid>1152921504606856053</PaymentTermUid>       </PaymentTermIdentity>
  <b:UdfName>CL-Stoplight</b:UdfName>
   <PurchaseOrderNumber>Acme 123</PurchaseOrderNumber>       <StandardBillingAdjustedDiscountPercent i:nil="true"/>       <StandardContractDiscountPercent i:nil="true"/>       <StandardRateCardIdentity i:nil="true"/><b:UdfUid>1152921504606856814</b:UdfUid>
      <TimeBillingType>H</TimeBillingType>       <Timestamp>AAAAAA61PAw=</Timestamp>       <UserDefinedFields>       <b:BooleanValue i:nil="true"/>
 <PwsUserDefinedFieldDetail>             <UdfId i:nil="true"/>             <UdfName>Sign On Date</UdfName><b:DataType>S</b:DataType>
              <UdfUid>1152921504606856792</UdfUid>             <BooleanValue<b:DateValue i:nil="true"/>
            <DataType>D</DataType>             <DateValue>2017-12-21T00:00:00Z</DateValue>             <IntegerValue <b:IntegerValue i:nil="true"/>
            <ResourceIdentityValue i:nil="true"/>               <TextValue<b:ResourceIdentityValue i:nil="true"/>

           <UdfTreatment>A</UdfTreatment>             <StoplightValues/>             <NumericValue<b:TextValue i:nil="true"/>
                <RelationValue i:nil="true"/>          </PwsUserDefinedFieldDetail><b:UdfTreatment>A</b:UdfTreatment>
          <PwsUserDefinedFieldDetail>             <UdfId i:nil="true"/>   <b:StoplightValues>
         <UdfName>Contact Name</UdfName>             <UdfUid>1152921504606856794</UdfUid>       <b:PwsStoplightValue>
     <BooleanValue i:nil="true"/>             <DataType>R</DataType>             <DateValue i:nil="true"/> <b:AsOfDate>2018-01-17T00:00:00Z</b:AsOfDate>
            <IntegerValue i:nil="true"/>             <ResourceIdentityValue>       <b:SortOrder>2</b:SortOrder>
        <ResourceDisplayName>John Smith</ResourceDisplayName>                <ResourceId i:nil="true"/>    </b:PwsStoplightValue>
           <ResourceReferenceSystemId>SL (USA) - 03</ResourceReferenceSystemId>              </b:StoplightValues>
 <ResourceUid>1152921504607062225</ResourceUid>             </ResourceIdentityValue>             <TextValue<b:NumericValue i:nil="true"/>
          
 <UdfTreatment>A</UdfTreatment>             <StoplightValues/>             <NumericValue<b:RelationValue i:nil="true"/>
             <RelationValue i:nil="true"/>          </b:PwsUserDefinedFieldDetail>
         <PwsUserDefinedFieldDetail>              <UdfId i:nil="true"/><b:PwsUserDefinedFieldDetail>
                           <UdfName>Additional Info</UdfName><b:UdfId i:nil="true"/>
             <UdfUid>1152921504606856795</UdfUid>             <BooleanValue i:nil="true"/><b:UdfName>CL-Multiline</b:UdfName>
             <DataType>T</DataType>             <DateValue i:nil="true"/><b:UdfUid>1152921504606858027</b:UdfUid>
             <IntegerValue i:nil="true"/>             <ResourceIdentityValue<b:BooleanValue i:nil="true"/>
            <TextValue>Client Info pending</TextValue>             <UdfTreatment>A</UdfTreatment>
            <StoplightValues/><b:DataType>T</b:DataType>
              <NumericValue i:nil="true"/>             <RelationValue<b:DateValue i:nil="true"/>
         </PwsUserDefinedFieldDetail>          <PwsUserDefinedFieldDetail>             <UdfId<b:IntegerValue i:nil="true"/>
            <UdfName>Grade</UdfName>             <UdfUid>1152921504606856796</UdfUid>             <BooleanValue <b:ResourceIdentityValue i:nil="true"/>
            <DataType>L</DataType>              <DateValue i:nil="true"/>
            <IntegerValue i:nil="true"/><b:TextValue>This is a parent client.</b:TextValue>
             <ResourceIdentityValue i:nil="true"/>             <TextValue>CL-1A</TextValue><b:UdfTreatment>A</b:UdfTreatment>
              <UdfTreatment>A</UdfTreatment>             <StoplightValues<b:StoplightValues/>
            <NumericValue i:nil="true"/>               <RelationValue<b:NumericValue i:nil="true"/>
         </PwsUserDefinedFieldDetail>          <PwsUserDefinedFieldDetail>             <UdfId <b:RelationValue i:nil="true"/>
            <UdfName>Category</UdfName>/>
            <UdfUid>1152921504606856797</UdfUid>             <BooleanValue>true<</BooleanValue>b:PwsUserDefinedFieldDetail>
            <DataType>Y</DataType>         </b:UserDefinedFields>
   <DateValue i:nil="true"/>             <IntegerValue i:nil="true"/>   <b:InheritInvoiceEmailSettingsFlag>false</b:InheritInvoiceEmailSettingsFlag>
         <ResourceIdentityValue i:nil="true"/>             <TextValue i:nil="true"/>
    <b:InvoiceEmailSettings>
       <UdfTreatment>A</UdfTreatment>             <StoplightValues/>    <b:EmailFromUserIdentity>
        <NumericValue i:nil="true"/>             <RelationValue i:nil="true"/>    <b:UserDisplayName>Betty Smith</b:UserDisplayName>
    </PwsUserDefinedFieldDetail>          <PwsUserDefinedFieldDetail>             <UdfId<b:UserId i:nil="true"/>
            <UdfName>Satisfaction</UdfName>               <b:UserReferenceSystemId>Partner - <UdfUid>1152921504606856814</UdfUid>01</b:UserReferenceSystemId>
             <BooleanValue i:nil="true"/>             <DataType>S</DataType><b:UserUid>1152921504607011056</b:UserUid>
            <DateValue i:nil="true"/>           </b:EmailFromUserIdentity>
 <IntegerValue i:nil="true"/>             <ResourceIdentityValue i:nil="true"/>        <b:EmailInvoiceTemplateIdentity>
    <TextValue i:nil="true"/>             <UdfTreatment>A</UdfTreatment>         <b:InvoiceTemplateId i:nil="true"/>
  <StoplightValues>                <PwsStoplightValue>          <b:InvoiceTemplateName>E001</b:InvoiceTemplateName>
        <AsOfDate>2017-12-21T00:00:00Z</AsOfDate>                   <SortOrder>3</SortOrder><b:InvoiceTemplateUid>1152921504606878906</b:InvoiceTemplateUid>
               </PwsStoplightValue>
            </StoplightValues>b:EmailInvoiceTemplateIdentity>
            <NumericValue i:nil="true"/>           <b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
 <RelationValue i:nil="true"/>          </PwsUserDefinedFieldDetail>          <PwsUserDefinedFieldDetail>   <b:InvoiceEmailType>P</b:InvoiceEmailType>
         <UdfId i:nil="true"/>               <b:Recipients>
<UdfName>Headquarters</UdfName>             <UdfUid>1152921504606858027</UdfUid>             <BooleanValue i:nil="true"/><b:PwsInvoiceEmailRecipient>
            <DataType>T</DataType>             <DateValue i:nil="true"/>    <b:RecipientType>T</b:RecipientType>
        <IntegerValue i:nil="true"/>             <ResourceIdentityValue i:nil="true"/>       <b:UserIdentity>
     <TextValue>This cllient has an additional location in San Francisco, CA.</TextValue>               <UdfTreatment>A</UdfTreatment>     <b:UserDisplayName>Abby Whelan</b:UserDisplayName>
      <StoplightValues/>             <NumericValue i:nil="true"/>             <RelationValue<b:UserId i:nil="true"/>
         </PwsUserDefinedFieldDetail>       </UserDefinedFields>       <InheritInvoiceEmailSettingsFlag>false</InheritInvoiceEmailSettingsFlag>       <InvoiceEmailSettings>   <b:UserReferenceSystemId>OPA02</b:UserReferenceSystemId>
      <EmailFromUserIdentity>             <UserDisplayName>Jane Doe</UserDisplayName>             <UserId i:nil="true"/><b:UserUid>1152921504607062210</b:UserUid>
               <UserReferenceSystemId>Employee - 123</UserReferenceSystemId>             <UserUid>1152921504607011056</UserUid></b:UserIdentity>
          </EmailFromUserIdentity>          <EmailInvoiceTemplateIdentity>       </b:PwsInvoiceEmailRecipient>
     <InvoiceTemplateId i:nil="true"/>             <InvoiceTemplateName>E001</InvoiceTemplateName>     </b:Recipients>
       <InvoiceTemplateUid>1152921504606878906</InvoiceTemplateUid>          </EmailInvoiceTemplateIdentity>    </b:InvoiceEmailSettings>
     <InvoiceEmailEnabledFlag>true</InvoiceEmailEnabledFlag>          <InvoiceEmailType>P</InvoiceEmailType>      <b:InheritRenderReceiptsFlag>false</b:InheritRenderReceiptsFlag>
   <Recipients>             <PwsInvoiceEmailRecipient>     <b:RenderReceiptsFlag>false</b:RenderReceiptsFlag>
          <RecipientType>T</RecipientType>           <b:AutoApplyAvailableBalanceFlag>false</b:AutoApplyAvailableBalanceFlag>
    <UserIdentity>                   <UserDisplayName>Web Services</UserDisplayName><b:InheritAutoApplyAvailableBalanceFlag>false</b:InheritAutoApplyAvailableBalanceFlag>
                    <UserId i:nil="true"/><b:InheritTaxTypesFlag>false</b:InheritTaxTypesFlag>
                  <UserReferenceSystemId>WS01</UserReferenceSystemId>   <b:TaxType1Identity>
               <UserUid>1152921504607067736</UserUid>         <b:TaxTypeCode>VAT</b:TaxTypeCode>
      </UserIdentity>             </PwsInvoiceEmailRecipient>          </Recipients><b:TaxTypeId i:nil="true"/>
      </InvoiceEmailSettings>       <InheritRenderReceiptsFlag>false</InheritRenderReceiptsFlag>       <RenderReceiptsFlag>false</RenderReceiptsFlag>       <AutoApplyAvailableBalanceFlag>false</AutoApplyAvailableBalanceFlag><b:TaxTypeUid>1152921504606868258</b:TaxTypeUid>
       <InheritAutoApplyAvailableBalanceFlag>false</InheritAutoApplyAvailableBalanceFlag>       <InheritTaxTypesFlag>false</InheritTaxTypesFlag>       <TaxType1Identity></b:TaxType1Identity>
           <TaxTypeCode>VAT</TaxTypeCode>          <TaxTypeId<b:TaxType2Identity i:nil="true"/>
         <TaxTypeUid>1152921504606868258</TaxTypeUid>       </TaxType1Identity>     <b:TaxType3Identity  <TaxType2Identity i:nil="true"/>
        <TaxType3Identity i:nil="true"/>          </b:ClientDetail>
  </PwsClientElement>     Table of Contents  Overview Format   </b:PwsClientElement>