Versions Compared

Old Version 11

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 updatedis 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?
Default

Description

Sample Data

ClientDetail

PwsClientDetail

Yes

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

Click here for more information.


Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
01
collapsetrue
                <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>
                    <ClientDetail> <b:InheritStandardRatesFlag>false</b:InheritStandardRatesFlag>
                    <ClientId i:nil="true"/><b:InheritTimeBillingTypeFlag>false</b:InheritTimeBillingTypeFlag>
                     <ClientNumber>PR-PSA(W)</ClientNumber><b:InvoiceContent>B</b:InvoiceContent>
                     <ClientUid>1152921504606989822</ClientUid><b:InvoiceScope>E</b:InvoiceScope>
                     <ClientName>Projector<b:InvoiceTemplateIdentity>
PSA - West</ClientName>                      <InactiveFlag>false</InactiveFlag><b:InvoiceTemplateId i:nil="true"/>
                        <ParentClientIdentity><b:InvoiceTemplateName>A100</b:InvoiceTemplateName>
                        <ClientId i:nil="true"/><b:InvoiceTemplateUid>1152921504606878901</b:InvoiceTemplateUid>
                     </b:InvoiceTemplateIdentity>
  <ClientNumber>PR-PSA</ClientNumber>                   <b:NewClientNumber i:nil="true"/>
    <ClientUid>1152921504606961482</ClientUid>                 <b:PaymentTermIdentity>
    </ParentClientIdentity>                    <b:PaymentTermId  <Address>i:nil="true"/>
                         <AddressLine1>85 Merrimac Street</AddressLine1><b:PaymentTermName>Net 30</b:PaymentTermName>
                        <AddressLine2>200</AddressLine2><b:PaymentTermUid>1152921504606856054</b:PaymentTermUid>
                      </b:PaymentTermIdentity>
 <Attention>Finance</Attention>                    <b:PurchaseOrderNumber>P-001</b:PurchaseOrderNumber>
    <City>Boston</City>                 <b:StandardBillingAdjustedDiscountPercent>5</b:StandardBillingAdjustedDiscountPercent>
       <CompanyName>Projector PSA</CompanyName>             <b:StandardContractDiscountPercent>10</b:StandardContractDiscountPercent>
           <Country>USA</Country>          <b:StandardRateCardIdentity>
              <StateOrProvince>MA</StateOrProvince>           <b:RateCardId i:nil="true"/>
            <ZipOrPostalCode>02114</ZipOrPostalCode>            <b:RateCardName>USA Rate Card</b:RateCardName>
       </Address>                 <b:RateCardType>R</b:RateCardType>
    <BillingCycleIdentity>                    <b:RateCardUid>1152921504606860819</b:RateCardUid>
    <BillingCycleId i:nil="true"/>                </b:StandardRateCardIdentity>
        <BillingCycleName>Monthly</BillingCycleName>             <b:TimeBillingType>H</b:TimeBillingType>
           <BillingCycleUid>1152921504606853180</BillingCycleUid>          <b:Timestamp>AAAAAA97WG8=</b:Timestamp>
           </BillingCycleIdentity>          <b:UserDefinedFields>
           <BillingInstructions>This client should be billed on the 15th of each month.</BillingInstructions>   <b:PwsUserDefinedFieldDetail>
                  <ClientMessage>{\rtf1\ansi\ansicpg1252\deff0{\fonttbl{\f0\fnil\fcharset0 Microsoft Sans Serif;}}
\viewkind4\uc1\pard\lang1033\f0\fs17 Thank you for your business!\par
}</ClientMessage>        <b:UdfId i:nil="true"/>
                       <ClientMessagePlain>Thank you for your business!</ClientMessagePlain> <b:UdfName>CL-Date</b:UdfName>
                     <InheritAddressFlag>true</InheritAddressFlag>      <b:UdfUid>1152921504606856792</b:UdfUid>
               <InheritBillingCycleFlag>true</InheritBillingCycleFlag>            <b:BooleanValue i:nil="true"/>
          <InheritBillingInstructionsFlag>true</InheritBillingInstructionsFlag>                 <b:DataType>D</b:DataType>
     <InheritClientMessageFlag>true</InheritClientMessageFlag>                      <InheritInvoiceContentFlag>false</InheritInvoiceContentFlag><b:DateValue>2018-01-17T00:00:00Z</b:DateValue>
                      <InheritInvoiceScopeFlag>false</InheritInvoiceScopeFlag>     <b:IntegerValue i:nil="true"/>
                <InheritInvoiceTemplateFlag>true</InheritInvoiceTemplateFlag>           <b:ResourceIdentityValue i:nil="true"/>
         <InheritPaymentTermFlag>true</InheritPaymentTermFlag>                  <b:TextValue i:nil="true"/>
  <InheritPurchaseOrderNumberFlag>true</InheritPurchaseOrderNumberFlag>                      <InheritStandardRatesFlag>true</InheritStandardRatesFlag>   <b:UdfTreatment>A</b:UdfTreatment>
                  <InheritTimeBillingTypeFlag>true</InheritTimeBillingTypeFlag>         <b:StoplightValues/>
            <InvoiceContent>B</InvoiceContent>               <b:NumericValue i:nil="true"/>
     <InvoiceScope>E</InvoiceScope>                      <InvoiceTemplateIdentity>
<b:RelationValue i:nil="true"/>
                       <InvoiceTemplateId i:nil="true"/></b:PwsUserDefinedFieldDetail>
                        <InvoiceTemplateName>A200</InvoiceTemplateName><b:PwsUserDefinedFieldDetail>
                        <InvoiceTemplateUid>1152921504606878904</InvoiceTemplateUid>   <b:UdfId i:nil="true"/>
                 </InvoiceTemplateIdentity>            <b:UdfName>CL-Integer</b:UdfName>
         <NewClientNumber i:nil="true"/>                 <b:UdfUid>1152921504606856793</b:UdfUid>
    <PaymentTermIdentity>                       <b:BooleanValue  <PaymentTermId i:nil="true"/>
                         <PaymentTermName>Net  30</PaymentTermName><b:DataType>I</b:DataType>
                            <PaymentTermUid>1152921504606856054</PaymentTermUid><b:DateValue i:nil="true"/>
                           </PaymentTermIdentity><b:IntegerValue>10</b:IntegerValue>
                     <PurchaseOrderNumber>PR-PSA01</PurchaseOrderNumber>      <b:ResourceIdentityValue i:nil="true"/>
              <StandardBillingAdjustedDiscountPercent>5</StandardBillingAdjustedDiscountPercent>             <b:TextValue i:nil="true"/>
       <StandardContractDiscountPercent>10</StandardContractDiscountPercent>                    <b:UdfTreatment>A</b:UdfTreatment>
 <StandardRateCardIdentity>                         <RateCardId i:nil="true"<b:StoplightValues/>
                        <RateCardName>USA  Rate Card</RateCardName><b:NumericValue>10</b:NumericValue>
                           <RateCardType>R</RateCardType><b:RelationValue i:nil="true"/>
                        <RateCardUid>1152921504606860819<</RateCardUid>b:PwsUserDefinedFieldDetail>
                     </StandardRateCardIdentity>   <b:PwsUserDefinedFieldDetail>
                  <TimeBillingType>H</TimeBillingType>         <b:UdfId i:nil="true"/>
            <Timestamp>AAAAAA61kSU=</Timestamp>               <b:UdfName>CL-Resource</b:UdfName>
      <UserDefinedFields>                     <b:UdfUid>1152921504606856794</b:UdfUid>
   <PwsUserDefinedFieldDetail>                            <UdfId <b:BooleanValue i:nil="true"/>
                           <UdfName>Sign On Date</UdfName><b:DataType>R</b:DataType>
                            <UdfUid>1152921504606856792</UdfUid><b:DateValue i:nil="true"/>
                           <BooleanValue<b:IntegerValue i:nil="true"/>
                           <DataType>D</DataType><b:ResourceIdentityValue>
                              <DateValue>2018-01-01T00:00:00Z</DateValue><b:ResourceDisplayName>John Doe</b:ResourceDisplayName>
                              <IntegerValue<b:ResourceId i:nil="true"/>
                             <ResourceIdentityValue i:nil="true"/><b:ResourceReferenceSystemId>E123</b:ResourceReferenceSystemId>
                             <TextValue i:nil="true"/><b:ResourceUid>1152921504607062225</b:ResourceUid>
                           <UdfTreatment>A<</UdfTreatment>b:ResourceIdentityValue>
                           <StoplightValues<b:TextValue i:nil="true"/>
                           <NumericValue i:nil="true"/><b:UdfTreatment>A</b:UdfTreatment>
                           <RelationValue i:nil="true"/><b:StoplightValues/>
                            </PwsUserDefinedFieldDetail><b:NumericValue i:nil="true"/>
                        <PwsUserDefinedFieldDetail>   <b:RelationValue i:nil="true"/>
                       <UdfId i:nil="true"/></b:PwsUserDefinedFieldDetail>
                         <b:PwsUserDefinedFieldDetail>
 <UdfName>Account Owner</UdfName>                            <UdfUid>1152921504606856794</UdfUid><b:UdfId i:nil="true"/>
                           <BooleanValue i:nil="true"/><b:UdfName>CL-Text</b:UdfName>
                           <DataType>R</DataType><b:UdfUid>1152921504606856795</b:UdfUid>
                           <DateValue<b:BooleanValue i:nil="true"/>
                           <IntegerValue i:nil="true"/><b:DataType>T</b:DataType>
                           <ResourceIdentityValue>
<b:DateValue i:nil="true"/>
                             <ResourceDisplayName>Jack Spratt</ResourceDisplayName><b:IntegerValue i:nil="true"/>
                              <ResourceId<b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>Parent   <ResourceReferenceSystemId>E123</ResourceReferenceSystemId>Client</b:TextValue>
                           <b:UdfTreatment>A</b:UdfTreatment>
                          <ResourceUid>1152921504607111573</ResourceUid> <b:StoplightValues/>
                           </ResourceIdentityValue><b:NumericValue i:nil="true"/>
                           <TextValue<b:RelationValue i:nil="true"/>
                           <UdfTreatment>A</UdfTreatment></b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
  <StoplightValues/>                            <NumericValue<b:UdfId i:nil="true"/>
                           <RelationValue i:nil="true"/><b:UdfName>CL-Text List</b:UdfName>
                           </PwsUserDefinedFieldDetail><b:UdfUid>1152921504606856796</b:UdfUid>
                           <PwsUserDefinedFieldDetail>
<b:BooleanValue i:nil="true"/>
                          <UdfId i:nil="true"/><b:DataType>L</b:DataType>
                           <UdfName>Grade</UdfName><b:DateValue i:nil="true"/>
                            <UdfUid>1152921504606856796</UdfUid><b:IntegerValue i:nil="true"/>
                           <BooleanValue<b:ResourceIdentityValue i:nil="true"/>
                           <DataType>L</DataType><b:TextValue>CL-1A</b:TextValue>
                           <DateValue i:nil="true"/><b:UdfTreatment>A</b:UdfTreatment>
                           <IntegerValue i:nil="true"<b:StoplightValues/>
                           <ResourceIdentityValue<b:NumericValue i:nil="true"/>
                            <TextValue>CL-2B</TextValue><b:RelationValue i:nil="true"/>
                           <UdfTreatment>A</UdfTreatment></b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
  <StoplightValues/>                            <NumericValue <b:UdfId i:nil="true"/>
                           <RelationValue i:nil="true"/><b:UdfName>CL-Boolean</b:UdfName>
                           </PwsUserDefinedFieldDetail><b:UdfUid>1152921504606856797</b:UdfUid>
                          <PwsUserDefinedFieldDetail> <b:BooleanValue>true</b:BooleanValue>
                          <UdfId i:nil="true"/><b:DataType>Y</b:DataType>
                            <UdfName>Category</UdfName><b:DateValue i:nil="true"/>
                           <UdfUid>1152921504606856797</UdfUid><b:IntegerValue i:nil="true"/>
                            <BooleanValue>true</BooleanValue><b:ResourceIdentityValue i:nil="true"/>
                            <DataType>Y</DataType><b:TextValue i:nil="true"/>
                           <DateValue i:nil="true"/><b:UdfTreatment>A</b:UdfTreatment>
                           <IntegerValue i:nil="true"<b:StoplightValues/>
                           <ResourceIdentityValue<b:NumericValue i:nil="true"/>
                           <TextValue<b:RelationValue i:nil="true"/>
                           <UdfTreatment>A</UdfTreatment></b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
  <StoplightValues/>                            <NumericValue <b:UdfId i:nil="true"/>
                           <RelationValue i:nil="true"/><b:UdfName>CL-Stoplight</b:UdfName>
                           </PwsUserDefinedFieldDetail><b:UdfUid>1152921504606856814</b:UdfUid>
                          <PwsUserDefinedFieldDetail> <b:BooleanValue i:nil="true"/>
                         <UdfId  i:nil="true"/><b:DataType>S</b:DataType>
                            <UdfName>Satisfaction</UdfName><b:DateValue i:nil="true"/>
                           <UdfUid>1152921504606856814</UdfUid><b:IntegerValue i:nil="true"/>
                           <BooleanValue<b:ResourceIdentityValue i:nil="true"/>
                           <DataType>S</DataType> <b:TextValue i:nil="true"/>
                           <DateValue i:nil="true"/><b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues>
    <IntegerValue i:nil="true"/>                          <b:PwsStoplightValue>
   <ResourceIdentityValue i:nil="true"/>                            <TextValue i:nil="true"/> <b:AsOfDate>2018-01-17T00:00:00Z</b:AsOfDate>
                                 <UdfTreatment>A</UdfTreatment><b:SortOrder>2</b:SortOrder>
                              </b:PwsStoplightValue>
  <StoplightValues>                         </b:StoplightValues>
     <PwsStoplightValue>                      <b:NumericValue i:nil="true"/>
          <AsOfDate>2018-01-12T00:00:00Z</AsOfDate>                 <b:RelationValue i:nil="true"/>
                <SortOrder>2</SortOrder>        </b:PwsUserDefinedFieldDetail>
                        </PwsStoplightValue><b:PwsUserDefinedFieldDetail>
                           </StoplightValues><b:UdfId i:nil="true"/>
                           <NumericValue i:nil="true"/><b:UdfName>CL-Multiline</b:UdfName>
                           <RelationValue i:nil="true"/><b:UdfUid>1152921504606858027</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
  </PwsUserDefinedFieldDetail>                         <PwsUserDefinedFieldDetail><b:DataType>T</b:DataType>
                           <UdfId<b:DateValue i:nil="true"/>
                            <UdfName>Headquarters</UdfName><b:IntegerValue i:nil="true"/>
                            <UdfUid>1152921504606858027</UdfUid><b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>This is a <BooleanValue i:nil="true"/>parent client.</b:TextValue>
                           <DataType>T</DataType><b:UdfTreatment>A</b:UdfTreatment>
                           <DateValue i:nil="true"<b:StoplightValues/>
                           <IntegerValue<b:NumericValue i:nil="true"/>
                           <ResourceIdentityValue<b:RelationValue i:nil="true"/>
                           <TextValue>Racepoint, CA</TextValue></b:PwsUserDefinedFieldDetail>
                     </b:UserDefinedFields>
     <UdfTreatment>A</UdfTreatment>                <b:InheritInvoiceEmailSettingsFlag>false</b:InheritInvoiceEmailSettingsFlag>
           <StoplightValues/>          <b:InvoiceEmailSettings>
                 <NumericValue i:nil="true"/>      <b:EmailFromUserIdentity>
                     <RelationValue i:nil="true"/>       <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                 </PwsUserDefinedFieldDetail>          <b:UserId i:nil="true"/>
          </UserDefinedFields>                 <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
  <InheritInvoiceEmailSettingsFlag>false</InheritInvoiceEmailSettingsFlag>                      <InvoiceEmailSettings>   <b:UserUid>1152921504607011056</b:UserUid>
                     <EmailFromUserIdentity>   </b:EmailFromUserIdentity>
                        <UserDisplayName>Bob Smith</UserDisplayName><b:EmailInvoiceTemplateIdentity>
                           <b:InvoiceTemplateId <UserId i:nil="true"/>
                           <UserReferenceSystemId>Partner - 01</UserReferenceSystemId><b:InvoiceTemplateName>E001</b:InvoiceTemplateName>
                           <UserUid>1152921504607011056</UserUid><b:InvoiceTemplateUid>1152921504606878906</b:InvoiceTemplateUid>
                        </EmailFromUserIdentity>b:EmailInvoiceTemplateIdentity>
                        <EmailInvoiceTemplateIdentity>
  <b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
                        <InvoiceTemplateId i:nil="true"/><b:InvoiceEmailType>P</b:InvoiceEmailType>
                        <b:Recipients>
  <InvoiceTemplateName>E001</InvoiceTemplateName>                         <b:PwsInvoiceEmailRecipient>
  <InvoiceTemplateUid>1152921504606878906</InvoiceTemplateUid>                         </EmailInvoiceTemplateIdentity>   <b:RecipientType>T</b:RecipientType>
                     <InvoiceEmailEnabledFlag>true</InvoiceEmailEnabledFlag>          <b:UserIdentity>
              <InvoiceEmailType>P</InvoiceEmailType>                   <b:UserDisplayName>Abby Whelan</b:UserDisplayName>
    <Recipients>                            <PwsInvoiceEmailRecipient> <b:UserId i:nil="true"/>
                            <RecipientType>T</RecipientType>     <b:UserReferenceSystemId>OPA02</b:UserReferenceSystemId>
                         <UserIdentity>         <b:UserUid>1152921504607062210</b:UserUid>
                        <UserDisplayName>Jack Spratt</UserDisplayName>     </b:UserIdentity>
                           </b:PwsInvoiceEmailRecipient>
<UserId i:nil="true"/>                       </b:Recipients>
          <UserReferenceSystemId>E123</UserReferenceSystemId>           </b:InvoiceEmailSettings>
                      <UserUid>1152921504607112369</UserUid><b:InheritRenderReceiptsFlag>false</b:InheritRenderReceiptsFlag>
                     <b:RenderReceiptsFlag>false</b:RenderReceiptsFlag>
        </UserIdentity>             <b:AutoApplyAvailableBalanceFlag>false</b:AutoApplyAvailableBalanceFlag>
              </PwsInvoiceEmailRecipient>       <b:InheritAutoApplyAvailableBalanceFlag>false</b:InheritAutoApplyAvailableBalanceFlag>
                 </Recipients>         <b:InheritTaxTypesFlag>false</b:InheritTaxTypesFlag>
            </InvoiceEmailSettings>         <b:TaxType1Identity>
            <InheritRenderReceiptsFlag>false</InheritRenderReceiptsFlag>            <b:TaxTypeCode>VAT</b:TaxTypeCode>
         <RenderReceiptsFlag>false</RenderReceiptsFlag>               <b:TaxTypeId i:nil="true"/>
     <AutoApplyAvailableBalanceFlag>false</AutoApplyAvailableBalanceFlag>                      <InheritAutoApplyAvailableBalanceFlag>false</InheritAutoApplyAvailableBalanceFlag><b:TaxTypeUid>1152921504606868258</b:TaxTypeUid>
                     <InheritTaxTypesFlag>false<</InheritTaxTypesFlag>b:TaxType1Identity>
                     <TaxType1Identity<b:TaxType2Identity i:nil="true"/>
                     <TaxType2Identity<b:TaxType3Identity i:nil="true"/>
                     <TaxType3Identity i:nil="true"/>
  </b:ClientDetail>
               </ClientDetail>b:PwsClientElement>