Versions Compared

Key

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

...

This web service inserts or updates a single client based on a detailed client structure (PwsClientDetail). The service returns the identity (PwsClientRef) of the client that has been inserted or updated. The caller can optionally request that the full client detail (PwsClientDetailPwsClientElement) be included in the response.

...

Panel
titlePwsSaveClient Request

...

ElementData TypeRequired?DefaultDescriptionSample Data
RequestIdInt32No
Click here for more information.
1
SessionTicketString (50)Yes
Click here for more information.
AavFwbZgVb9V4tr3R7BbzQ==
Client DetailPwsClientDetailYes
The detailed client information to be inserted or updated.
FullDetailFlagBooleanNofalseValid values include "true" or "false". If set to " true" , include full detailed client element in response
true/false
ParentClientClearFlagBooleanNofalseValid values include "true" or "false". If set to " true" null out , the parent client will be set to null
true/false

Request Usage Example(s)


Code Block
languagexml
titleExample 01New Client
collapsetrue
<soapenv:Envelope      <PwsSaveClient>
 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
   <serviceRequest>   <pws:PwsSaveClient>
         <!--RequestId>?</RequestId--><pws:serviceRequest>
            <SessionTicket>AcjOqKSXoUYG3qLkrxKQYw==</SessionTicket><req:RequestId>1</req:RequestId>
            <Client><req:SessionTicket>AVPtg8pZ/KFy3PWleHmQEw==</req:SessionTicket>
             <req:Client>
 <!--ClientId>?</ClientId-->              <com:ClientName>SOAP  <!--ClientNumber>?</ClientNumber-->UI A</com:ClientName>
               <!--ClientUid>?</ClientUid--><com:InactiveFlag>false</com:InactiveFlag>
               <com:Address>
   <ClientName>Acme 1000-01</ClientName>              <com:AddressLine1>311 South <InactiveFlag>false<Wacker</InactiveFlag>com:AddressLine1>
               <ParentClientIdentity>   <com:AddressLine2>Suite 2300</com:AddressLine2>
              <!--ClientId>?</ClientId-->    <com:City>Chicago</com:City>
              <!--ClientNumber>?</ClientNumber-->    <com:CompanyName>SOAP UI A</com:CompanyName>
            <!--ClientUid>?</ClientUid-->      <com:Country>USA</com:Country>
         </ParentClientIdentity>         <com:StateOrProvince>Illinois</com:StateOrProvince>
      <Address>            <com:ZipOrPostalCode>60601</com:ZipOrPostalCode>
      <AddressLine1>123 Main Street</AddressLine1>       </com:Address>
           <AddressLine2>Suite 100</AddressLine2>   <com:BillingCycleIdentity>
               <Attention>Jane Smith</Attention>  <com:BillingCycleName>Monthly</com:BillingCycleName>
               </com:BillingCycleIdentity>
  <City>Boston</City>             <com:BillingInstructions>Please bill at the end of <CompanyName>Acmeeach 1000-01</CompanyName>month</com:BillingInstructions>
               <com:ClientMessage>Thank you for your <Country>USA</Country>business!</com:ClientMessage>
               <com:ClientMessagePlain>Thank you for your <StateOrProvince>MA</StateOrProvince>business!</com:ClientMessagePlain>
                  <ZipOrPostalCode>02114</ZipOrPostalCode><com:InheritAddressFlag>false</com:InheritAddressFlag>
               </Address><com:InheritBillingCycleFlag>false</com:InheritBillingCycleFlag>
               <BillingCycleIdentity><com:InheritBillingInstructionsFlag>false</com:InheritBillingInstructionsFlag>
                  <!--BillingCycleId>?</BillingCycleId--><com:InheritClientMessageFlag>false</com:InheritClientMessageFlag>
               <com:InheritInvoiceContentFlag>false</com:InheritInvoiceContentFlag>
  <BillingCycleName>Monthly</BillingCycleName>             <com:InheritInvoiceScopeFlag>false</com:InheritInvoiceScopeFlag>
     <!--BillingCycleUid>?</BillingCycleUid-->          <com:InheritInvoiceTemplateFlag>false</com:InheritInvoiceTemplateFlag>
     </BillingCycleIdentity>          <com:InheritPaymentTermFlag>false</com:InheritPaymentTermFlag>
     <BillingInstructions>Bill on the last day of the month</BillingInstructions>   <com:InheritPurchaseOrderNumberFlag>false</com:InheritPurchaseOrderNumberFlag>
            <ClientMessage>We appreciate your business!</ClientMessage> <com:InheritStandardRatesFlag>false</com:InheritStandardRatesFlag>
               <ClientMessagePlain>We appreciate your business!</ClientMessagePlain><com:InheritTimeBillingTypeFlag>false</com:InheritTimeBillingTypeFlag>
               <InheritAddressFlag>false</InheritAddressFlag><com:InvoiceContent>B</com:InvoiceContent>
               <InheritBillingCycleFlag>false</InheritBillingCycleFlag><com:InvoiceScope>E</com:InvoiceScope>
               <InheritBillingInstructionsFlag>false</InheritBillingInstructionsFlag><com:InvoiceTemplateIdentity>
               <InheritClientMessageFlag>false</InheritClientMessageFlag>   <com:InvoiceTemplateName>A200</com:InvoiceTemplateName>
            <InheritInvoiceContentFlag>false</InheritInvoiceContentFlag>   </com:InvoiceTemplateIdentity>
            <InheritInvoiceScopeFlag>false</InheritInvoiceScopeFlag>   <com:PaymentTermIdentity>
            <InheritInvoiceTemplateFlag>false</InheritInvoiceTemplateFlag>      <com:PaymentTermName>Net 30</com:PaymentTermName>
        <InheritPaymentTermFlag>false</InheritPaymentTermFlag>       </com:PaymentTermIdentity>
        <InheritPurchaseOrderNumberFlag>false</InheritPurchaseOrderNumberFlag>       <com:PurchaseOrderNumber>SOAP UI</com:PurchaseOrderNumber>
       <InheritStandardRatesFlag>false</InheritStandardRatesFlag>        <com:StandardBillingAdjustedDiscountPercent>10</com:StandardBillingAdjustedDiscountPercent>
       <InheritTimeBillingTypeFlag>false</InheritTimeBillingTypeFlag>        <com:StandardContractDiscountPercent>5</com:StandardContractDiscountPercent>
       <InvoiceContent>B</InvoiceContent>        <com:StandardRateCardIdentity>
       <InvoiceScope>E</InvoiceScope>           <com:RateCardName>USA</com:RateCardName>
    <InvoiceTemplateIdentity>              <com:RateCardType>R</com:RateCardType>
    <!--InvoiceTemplateId>?</InvoiceTemplateId-->           </com:StandardRateCardIdentity>
       <InvoiceTemplateName>A200</InvoiceTemplateName>        <com:TimeBillingType>H</com:TimeBillingType>
          <!--InvoiceTemplateUid>?</InvoiceTemplateUid-->     <com:InheritInvoiceEmailSettingsFlag>false</com:InheritInvoiceEmailSettingsFlag>
          </InvoiceTemplateIdentity>     <com:InvoiceEmailSettings>
          <NewClientNumber>C001001</NewClientNumber>        <com:EmailFromUserIdentity>
       <PaymentTermIdentity>              <com:UserDisplayName>Bettina</com:UserDisplayName>
    <!--PaymentTermId>?</PaymentTermId-->              </com:EmailFromUserIdentity>
    <PaymentTermName>Net 60</PaymentTermName>             <com:EmailInvoiceTemplateIdentity>
     <!--PaymentTermUid>?</PaymentTermUid-->                </PaymentTermIdentity><com:InvoiceTemplateName>E002</com:InvoiceTemplateName>
                  <PurchaseOrderNumber>C001000</PurchaseOrderNumber></com:EmailInvoiceTemplateIdentity>
                  <StandardBillingAdjustedDiscountPercent>0</StandardBillingAdjustedDiscountPercent><com:InvoiceEmailEnabledFlag>true</com:InvoiceEmailEnabledFlag>
                  <StandardContractDiscountPercent>0</StandardContractDiscountPercent><com:InvoiceEmailType>W</com:InvoiceEmailType>
                  <StandardRateCardIdentity><com:Recipients>
                  <!--RateCardId>?</RateCardId-->   <com:PwsInvoiceEmailRecipient>
               <RateCardName>USA Rate Card</RateCardName>       <com:RecipientType>T</com:RecipientType>
           <RateCardType>R</RateCardType>             <com:UserIdentity>
     <!--RateCardUid>?</RateCardUid-->                </StandardRateCardIdentity>      <com:UserDisplayName>SOAP UI</com:UserDisplayName>
        <TimeBillingType>H</TimeBillingType>                <!--Timestamp>?</Timestamp-->com:UserIdentity>
               <UserDefinedFields>      </com:PwsInvoiceEmailRecipient>
            <PwsUserDefinedFieldDetail>      </com:Recipients>
               <!--UdfId>?</UdfId-->/com:InvoiceEmailSettings>
               <com:InheritRenderReceiptsFlag>false</com:InheritRenderReceiptsFlag>
     <UdfName>Account Owner</UdfName>            <com:RenderReceiptsFlag>false</com:RenderReceiptsFlag>
         <!--UdfUid>?</UdfUid-->      <com:AutoApplyAvailableBalanceFlag>false</com:AutoApplyAvailableBalanceFlag>
               <!--BooleanValue>?</BooleanValue--><com:InheritAutoApplyAvailableBalanceFlag>false</com:InheritAutoApplyAvailableBalanceFlag>
               <com:InheritTaxTypesFlag>false</com:InheritTaxTypesFlag>
     <DataType>R</DataType>          <com:InheritRenderedInvoiceFormatFlag>false</com:InheritRenderedInvoiceFormatFlag>
           <!--DateValue>?</DateValue-->    <com:RenderedInvoiceFormat>P</com:RenderedInvoiceFormat>
                 <!--IntegerValue>?</IntegerValue--><com:Prefix>01312024</com:Prefix>
            </req:Client>
        <ResourceIdentityValue>    <req:FullDetailFlag>true</req:FullDetailFlag>
            <req:ParentClientClearFlag>false</req:ParentClientClearFlag>
       <ResourceDisplayName>Jack Spratt</ResourceDisplayName>    <req:DisallowDuplicateNameFlag>false</req:DisallowDuplicateNameFlag>
                    <!--ResourceId>?</ResourceId--><req:FixInheritanceFlag>false</req:FixInheritanceFlag>
         </pws:serviceRequest>
      </pws:PwsSaveClient>
       <ResourceReferenceSystemId>E123</ResourceReferenceSystemId>
                </soapenv:Body>
</soapenv:Envelope>


Code Block
languagexml
titleExample 01 - Client without Parent
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
       <!--ResourceUid>?</ResourceUid--><pws:PwsSaveClient>
         <pws:serviceRequest>
            </ResourceIdentityValue><req:RequestId>1</req:RequestId>
            <req:SessionTicket>AaBd4dMYPbBiEeXoiz50NQ==</req:SessionTicket>
        <!--TextValue>?</TextValue-->    <req:Client>
               <com:ClientNumber>C000158</com:ClientNumber>
 <UdfTreatment>A</UdfTreatment>              <com:InactiveFlag>false</com:InactiveFlag>
       <!--StoplightValues-->        <com:Address>
                <!--PwsStoplightValue-->  <com:AddressLine1>98 North Washington Street</com:AddressLine1>
                  <com:AddressLine2>400</com:AddressLine2>
   <!--AsOfDate>?</AsOfDate-->               <com:Attention>Office Administrator</com:Attention>
           <!--SortOrder>?</SortOrder-->       <com:City>Boston</com:City>
                 <!--/PwsStoplightValue-->
  <com:CompanyName>Projector PSA</com:CompanyName>
                   <!--/StoplightValues--><com:Country>USA</com:Country>
                  <com:StateOrProvince>MA</com:StateOrProvince>
  <!--NumericValue>?</NumericValue-->                <com:ZipOrPostalCode>02114</com:ZipOrPostalCode>
     <!--RelationValue-->          </com:Address>
              <!--CodeValue>?</CodeValue-->
 <com:BillingCycleIdentity>
                  <com:BillingCycleName>Monthly</com:BillingCycleName>
    <!--TextValue>?</TextValue-->           </com:BillingCycleIdentity>
               <!--UidValue>?</UidValue-->
  <com:BillingInstructions>Please bill on the last day of the month.</com:BillingInstructions>
               <com:ClientMessage>We appreciate your business.<!--/RelationValue-->/com:ClientMessage>
               <com:ClientMessagePlain>We appreciate your business.</PwsUserDefinedFieldDetail>com:ClientMessagePlain>
               </UserDefinedFields><com:InheritAddressFlag>false</com:InheritAddressFlag>
               <InheritInvoiceEmailSettingsFlag>false</InheritInvoiceEmailSettingsFlag><com:InheritBillingCycleFlag>false</com:InheritBillingCycleFlag>
               <InvoiceEmailSettings><com:InheritBillingInstructionsFlag>false</com:InheritBillingInstructionsFlag>
               <com:InheritClientMessageFlag>false</com:InheritClientMessageFlag>
  <EmailFromUserIdentity>               <com:InheritInvoiceContentFlag>false</com:InheritInvoiceContentFlag>
      <UserDisplayName>Bettina Borces</UserDisplayName>              <com:InheritInvoiceScopeFlag>false</com:InheritInvoiceScopeFlag>
       <!--UserId>?</UserId-->        <com:InheritInvoiceTemplateFlag>false</com:InheritInvoiceTemplateFlag>
             <UserReferenceSystemId>Partner - 01</UserReferenceSystemId><com:InheritPaymentTermFlag>false</com:InheritPaymentTermFlag>
               <com:InheritPurchaseOrderNumberFlag>false</com:InheritPurchaseOrderNumberFlag>
     <!--UserUid>?</UserUid-->          <com:InheritStandardRatesFlag>false</com:InheritStandardRatesFlag>
        </EmailFromUserIdentity>       <com:InheritTimeBillingTypeFlag>false</com:InheritTimeBillingTypeFlag>
           <EmailInvoiceTemplateIdentity>    <com:InvoiceContent>B</com:InvoiceContent>
               <com:InvoiceScope>E</com:InvoiceScope>
 <!--InvoiceTemplateId>?</InvoiceTemplateId-->              <com:InvoiceTemplateIdentity>
       <InvoiceTemplateName>E004</InvoiceTemplateName>           <com:InvoiceTemplateName>A200</com:InvoiceTemplateName>
          <!--InvoiceTemplateUid>?</InvoiceTemplateUid-->     </com:InvoiceTemplateIdentity>
             </EmailInvoiceTemplateIdentity>  <com:PaymentTermIdentity>
                <InvoiceEmailEnabledFlag>false</InvoiceEmailEnabledFlag>  <com:PaymentTermName>Net 30</com:PaymentTermName>
               <InvoiceEmailType>P<</InvoiceEmailType>com:PaymentTermIdentity>
               <com:PurchaseOrderNumber>PPSA</com:PurchaseOrderNumber>
  <Recipients>             <com:StandardBillingAdjustedDiscountPercent>15</com:StandardBillingAdjustedDiscountPercent>
        <PwsInvoiceEmailRecipient>       <com:StandardContractDiscountPercent>10</com:StandardContractDiscountPercent>
               <com:StandardRateCardIdentity>
 <RecipientType>T</RecipientType>                 <com:RateCardName>USA</com:RateCardName>
       <UserIdentity>           <com:RateCardType>R</com:RateCardType>
                <UserDisplayName>Jane Doe</UserDisplayName></com:StandardRateCardIdentity>
               <com:TimeBillingType>H</com:TimeBillingType>
           <!--UserId>?</UserId-->    <com:UserDefinedFields>
                  <com:PwsUserDefinedFieldDetail>
    <UserReferenceSystemId>E124</UserReferenceSystemId>                 <com:UdfName>CL-Text</com:UdfName>
          <!--UserUid>?</UserUid-->           <com:TextValue>Updated on November 6th, 2023</com:TextValue>
         </UserIdentity>          </com:PwsUserDefinedFieldDetail>
               </PwsInvoiceEmailRecipient>/com:UserDefinedFields>
               <com:InheritInvoiceEmailSettingsFlag>false</com:InheritInvoiceEmailSettingsFlag>
               <com:InvoiceEmailSettings>
                  <com:EmailFromUserIdentity>
     </Recipients>                </InvoiceEmailSettings><com:UserDisplayName>Bettina</com:UserDisplayName>
                  <InheritRenderReceiptsFlag>false</InheritRenderReceiptsFlag></com:EmailFromUserIdentity>
                       <RenderReceiptsFlag>false</RenderReceiptsFlag>
               <AutoApplyAvailableBalanceFlag>false</AutoApplyAvailableBalanceFlag>
               <InheritAutoApplyAvailableBalanceFlag>false</InheritAutoApplyAvailableBalanceFlag>
               <InheritTaxTypesFlag>false</InheritTaxTypesFlag>
               <TaxType1Identity>
       <com:EmailInvoiceTemplateIdentity>
                     <com:InvoiceTemplateName>E002</com:InvoiceTemplateName>
                  </com:EmailInvoiceTemplateIdentity>
                  <com:InvoiceEmailEnabledFlag>true</com:InvoiceEmailEnabledFlag>
                  <com:InvoiceEmailType>W</com:InvoiceEmailType>
                  <com:Recipients>
                     <com:PwsInvoiceEmailRecipient>
                        <com:RecipientType>T</com:RecipientType>
                        <com:UserIdentity>
                           <com:UserDisplayName>Template Client</com:UserDisplayName>
                        </com:UserIdentity>
                     </com:PwsInvoiceEmailRecipient>
                  </com:Recipients>
               </com:InvoiceEmailSettings>
               <com:InheritRenderReceiptsFlag>false</com:InheritRenderReceiptsFlag>
               <com:RenderReceiptsFlag>true</com:RenderReceiptsFlag>
               <com:AutoApplyAvailableBalanceFlag>false</com:AutoApplyAvailableBalanceFlag>
               <com:InheritAutoApplyAvailableBalanceFlag>false</com:InheritAutoApplyAvailableBalanceFlag>
               <com:InheritTaxTypesFlag>true</com:InheritTaxTypesFlag>
               <com:InheritRenderedInvoiceFormatFlag>false</com:InheritRenderedInvoiceFormatFlag>
               <com:RenderedInvoiceFormat>P</com:RenderedInvoiceFormat>
               <com:Prefix>11062023</com:Prefix>
            </req:Client>
            <req:FullDetailFlag>true</req:FullDetailFlag>
            <req:ParentClientClearFlag>false</req:ParentClientClearFlag>
            <req:DisallowDuplicateNameFlag>true</req:DisallowDuplicateNameFlag>
            <req:FixInheritanceFlag>false</req:FixInheritanceFlag>
         </pws:serviceRequest>
      </pws:PwsSaveClient>
   </soapenv:Body>
</soapenv:Envelope>


Code Block
languagexml
titleExample 02 - Client with parent
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsSaveClient>
         <pws:serviceRequest>
            <req:RequestId>2</req:RequestId>
            <req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
            <req:Client>
               <com:ClientName>Web Services Inc. - extended</com:ClientName>
               <com:InactiveFlag>false</com:InactiveFlag>
               <com:ParentClientIdentity>
                  <com:ClientNumber>C000124</com:ClientNumber>
               </com:ParentClientIdentity>
               <com:InheritAddressFlag>true</com:InheritAddressFlag>
               <com:InheritBillingCycleFlag>true</com:InheritBillingCycleFlag>
               <com:InheritBillingInstructionsFlag>true</com:InheritBillingInstructionsFlag>
               <com:InheritClientMessageFlag>true</com:InheritClientMessageFlag>
               <com:InheritInvoiceContentFlag>true</com:InheritInvoiceContentFlag>
               <com:InheritInvoiceScopeFlag>true</com:InheritInvoiceScopeFlag>
               <com:InheritInvoiceTemplateFlag>true</com:InheritInvoiceTemplateFlag>
               <com:InheritPaymentTermFlag>true</com:InheritPaymentTermFlag>
               <com:InheritPurchaseOrderNumberFlag>true</com:InheritPurchaseOrderNumberFlag>
               <com:InheritStandardRatesFlag>true</com:InheritStandardRatesFlag>
               <com:InheritTimeBillingTypeFlag>true</com:InheritTimeBillingTypeFlag>
               <com:UserDefinedFields>
                  <com:PwsUserDefinedFieldDetail>
                     <com:UdfName>CL-Date</com:UdfName>
                     <com:DateValue>2018-02-28T00:00:00Z</com:DateValue>
                  </com:PwsUserDefinedFieldDetail>
                  <com:PwsUserDefinedFieldDetail>
                     <com:UdfName>CL-Text</com:UdfName>
                     <com:TextValue>Child of Client C00124</com:TextValue>
                  </com:PwsUserDefinedFieldDetail>
               </com:UserDefinedFields>
               <com:InheritInvoiceEmailSettingsFlag>true</com:InheritInvoiceEmailSettingsFlag>
               <com:InheritRenderReceiptsFlag>true</com:InheritRenderReceiptsFlag>
               <com:InheritAutoApplyAvailableBalanceFlag>true</com:InheritAutoApplyAvailableBalanceFlag>
               <com:InheritTaxTypesFlag>true</com:InheritTaxTypesFlag>
            </req:Client>
            <req:FullDetailFlag>true</req:FullDetailFlag>
            <req:ParentClientClearFlag>false</req:ParentClientClearFlag>
         </pws:serviceRequest>
      </pws:PwsSaveClient>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


Panel
titlePwsSaveClientRs

Response Elements


ElementData TypeDescriptionSample Data
MessagesPwsMessage[]

The web service response status and message. Click here for more information


ResponseIdInt32Click here for more information0
StatusRequestStatusClick here for more informationOk
ServerTimestampUtcDateTimeClick here for more information
2017-12-27T16:48:52.6790058Z
ClientPwsClientElementThe complete set of information about the client
ClientIdentityPwsClientRefThe unique keys used to identify the client

Response Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveClientResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
          <TaxTypeCode>VAT</TaxTypeCode>
<PwsSaveClientResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages     <!--TaxTypeId>?</TaxTypeId--xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <!--TaxTypeUid>?</TaxTypeUid--><ResponseId xmlns="http://projectorpsa.com/CommonServices/">2</ResponseId>
               </TaxType1Identity><Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
               <!--TaxType2Identity--><ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-17T20:37:34.987952Z</ServerTimestampUtc>
            <a:Client xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
     <!--TaxTypeCode>?</TaxTypeCode-->          <b:ClientDetail>
        <!--TaxTypeId>?</TaxTypeId-->          <b:ClientId i:nil="true"/>
       <!--TaxTypeUid>?</TaxTypeUid-->           <b:ClientNumber>C000127</b:ClientNumber>
    <!--/TaxType2Identity-->              <b:ClientUid>1152921504606998468</b:ClientUid>
  <!--TaxType3Identity-->                <b:ClientName>Web Services Inc. <!--TaxTypeCode>?</TaxTypeCode-->- extended</b:ClientName>
                  <!--TaxTypeId>?</TaxTypeId--><b:InactiveFlag>false</b:InactiveFlag>
                  <b:ParentClientIdentity>
  <!--TaxTypeUid>?</TaxTypeUid-->                <!--/TaxType3Identity-->   <b:ClientId i:nil="true"/>
        </Client>             <FullDetailFlag>true</FullDetailFlag>
<b:ClientNumber>C000124</b:ClientNumber>
           <ParentClientClearFlag>false</ParentClientClearFlag>          </serviceRequest>
      </PwsSaveClient>

Response Format

Panel
titlePwsSaveClientRs

Response Elements

...

Response Usage Example(s)

Code Block
languagexml
titleExample 01
collapsetrue
<b:ClientUid>1152921504606998465</b:ClientUid>
                  </b:ParentClientIdentity>
                  <PwsSaveClientResponse><b:Address>
         <PwsSaveClientResult>            <b:AddressLine1>123 <MessagesMain i:nil="true"/Street</b:AddressLine1>
             <ResponseId>0</ResponseId>        <b:AddressLine2>Suite 100</b:AddressLine2>
   <Status>Ok</Status>             <ServerTimestampUtc>2017-12-27T16:48:52.6790058Z</ServerTimestampUtc>     <b:Attention>Billing</b:Attention>
       <Client>              <b:City>Boston</b:City>
 <ClientDetail>                   <ClientId i:nil="true"/><b:CompanyName>Acme Inc.</b:CompanyName>
                     <ClientNumber>C001001</ClientNumber><b:Country>USA</b:Country>
                     <ClientUid>1152921504606989819</ClientUid><b:StateOrProvince>MA</b:StateOrProvince>
                    <ClientName>Acme 1000-01</ClientName> <b:ZipOrPostalCode>02114</b:ZipOrPostalCode>
                  <InactiveFlag>false</InactiveFlag></b:Address>
                  <b:BillingCycleIdentity>
<ParentClientIdentity i:nil="true"/>                   <Address> <b:BillingCycleId i:nil="true"/>
                   <AddressLine1>123 Main Street</AddressLine1><b:BillingCycleName>Monthly</b:BillingCycleName>
                     <AddressLine2>Suite 100</AddressLine2><b:BillingCycleUid>1152921504606853180</b:BillingCycleUid>
                  </b:BillingCycleIdentity>
  <Attention>Jane Smith</Attention>               <b:BillingInstructions>Please bill on the last day  <City>Boston</City>of the month.</b:BillingInstructions>
                     <CompanyName>Acme 1000-01</CompanyName>
  <b:ClientMessage>We appreciate your business.</b:ClientMessage>
                  <Country>USA</Country>
  <b:ClientMessagePlain>We appreciate your business.</b:ClientMessagePlain>
                  <StateOrProvince>MA</StateOrProvince><b:InheritAddressFlag>true</b:InheritAddressFlag>
                  <b:InheritBillingCycleFlag>true</b:InheritBillingCycleFlag>
  <ZipOrPostalCode>02114</ZipOrPostalCode>                <b:InheritBillingInstructionsFlag>true</b:InheritBillingInstructionsFlag>
  </Address>                <b:InheritClientMessageFlag>true</b:InheritClientMessageFlag>
  <BillingCycleIdentity>                <b:InheritInvoiceContentFlag>true</b:InheritInvoiceContentFlag>
     <BillingCycleId i:nil="true"/>            <b:InheritInvoiceScopeFlag>true</b:InheritInvoiceScopeFlag>
         <BillingCycleName>Monthly</BillingCycleName>         <b:InheritInvoiceTemplateFlag>true</b:InheritInvoiceTemplateFlag>
            <BillingCycleUid>1152921504606853180</BillingCycleUid>      <b:InheritPaymentTermFlag>true</b:InheritPaymentTermFlag>
            </BillingCycleIdentity>       <b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag>
           <BillingInstructions>Bill on the last day of the month</BillingInstructions><b:InheritStandardRatesFlag>true</b:InheritStandardRatesFlag>
                  <ClientMessage>We appreciate your business!</ClientMessage><b:InheritTimeBillingTypeFlag>true</b:InheritTimeBillingTypeFlag>
                  <b:InvoiceContent>B</b:InvoiceContent>
  <ClientMessagePlain>We appreciate your business!</ClientMessagePlain>             <b:InvoiceScope>E</b:InvoiceScope>
     <InheritAddressFlag>false</InheritAddressFlag>             <b:InvoiceTemplateIdentity>
     <InheritBillingCycleFlag>false</InheritBillingCycleFlag>                   <InheritBillingInstructionsFlag>false</InheritBillingInstructionsFlag><b:InvoiceTemplateId i:nil="true"/>
                  <InheritClientMessageFlag>false</InheritClientMessageFlag>   <b:InvoiceTemplateName>A200</b:InvoiceTemplateName>
               <InheritInvoiceContentFlag>false</InheritInvoiceContentFlag>      <b:InvoiceTemplateUid>1152921504606878904</b:InvoiceTemplateUid>
            <InheritInvoiceScopeFlag>false</InheritInvoiceScopeFlag>      </b:InvoiceTemplateIdentity>
            <InheritInvoiceTemplateFlag>false</InheritInvoiceTemplateFlag>      <b:NewClientNumber i:nil="true"/>
           <InheritPaymentTermFlag>false</InheritPaymentTermFlag>       <b:PaymentTermIdentity>
           <InheritPurchaseOrderNumberFlag>false</InheritPurchaseOrderNumberFlag>          <b:PaymentTermId i:nil="true"/>
       <InheritStandardRatesFlag>false</InheritStandardRatesFlag>                <b:PaymentTermName>Net 60</b:PaymentTermName>
  <InheritTimeBillingTypeFlag>false</InheritTimeBillingTypeFlag>                   <InvoiceContent>B</InvoiceContent><b:PaymentTermUid>1152921504606856055</b:PaymentTermUid>
                  <InvoiceScope>E</InvoiceScope>    </b:PaymentTermIdentity>
              <InvoiceTemplateIdentity>    <b:PurchaseOrderNumber>WS-001</b:PurchaseOrderNumber>
                 <InvoiceTemplateId i:nil="true"/><b:StandardBillingAdjustedDiscountPercent>15</b:StandardBillingAdjustedDiscountPercent>
                  <b:StandardContractDiscountPercent>10</b:StandardContractDiscountPercent>
  <InvoiceTemplateName>A200</InvoiceTemplateName>                <b:StandardRateCardIdentity>
     <InvoiceTemplateUid>1152921504606878904</InvoiceTemplateUid>                <b:RateCardId i:nil="true"/>
 </InvoiceTemplateIdentity>                   <NewClientNumber i:nil="true"/><b:RateCardName>USA Rate Card</b:RateCardName>
                     <PaymentTermIdentity><b:RateCardType>R</b:RateCardType>
                     <b:RateCardUid>1152921504606860819</b:RateCardUid>
 <PaymentTermId i:nil="true"/>                </b:StandardRateCardIdentity>
     <PaymentTermName>Net 60</PaymentTermName>            <b:TimeBillingType>H</b:TimeBillingType>
         <PaymentTermUid>1152921504606856055</PaymentTermUid>         <b:Timestamp>AAAAAA97Yvs=</b:Timestamp>
         </PaymentTermIdentity>         <b:UserDefinedFields>
         <PurchaseOrderNumber>C001000</PurchaseOrderNumber>            <b:PwsUserDefinedFieldDetail>
      <StandardBillingAdjustedDiscountPercent>0</StandardBillingAdjustedDiscountPercent>                   <StandardContractDiscountPercent>0</StandardContractDiscountPercent><b:UdfId i:nil="true"/>
                  <StandardRateCardIdentity>      <b:UdfName>CL-Date</b:UdfName>
               <RateCardId i:nil="true"/>         <b:UdfUid>1152921504606856792</b:UdfUid>
            <RateCardName>USA Rate Card</RateCardName>          <b:BooleanValue i:nil="true"/>
          <RateCardType>R</RateCardType>              <b:DataType>D</b:DataType>
       <RateCardUid>1152921504606860819</RateCardUid>                   </StandardRateCardIdentity><b:DateValue>2018-02-28T00:00:00Z</b:DateValue>
                  <TimeBillingType>H</TimeBillingType>      <b:IntegerValue i:nil="true"/>
           <Timestamp>AAAAAA61TDI=</Timestamp>             <b:ResourceIdentityValue i:nil="true"/>
    <UserDefinedFields>                      <PwsUserDefinedFieldDetail><b:TextValue i:nil="true"/>
                        <UdfId i:nil="true"/><b:UdfTreatment>A</b:UdfTreatment>
                        <UdfName>Account Owner</UdfName><b:StoplightValues/>
                         <UdfUid>1152921504606856794</UdfUid><b:NumericValue i:nil="true"/>
                        <BooleanValue<b:RelationValue i:nil="true"/>
                        <DataType>R</DataType></b:PwsUserDefinedFieldDetail>
                        <DateValue i:nil="true"/><b:PwsUserDefinedFieldDetail>
                        <IntegerValue<b:UdfId i:nil="true"/>
                        <ResourceIdentityValue><b:UdfName>CL-Text</b:UdfName>
                           <ResourceDisplayName>Jack Spratt</ResourceDisplayName>
  <b:UdfUid>1152921504606856795</b:UdfUid>
                        <ResourceId<b:BooleanValue i:nil="true"/>
                           <ResourceReferenceSystemId>E123</ResourceReferenceSystemId><b:DataType>T</b:DataType>
                        <b:DateValue i:nil="true"/>
 <ResourceUid>1152921504607111573</ResourceUid>                         </ResourceIdentityValue><b:IntegerValue i:nil="true"/>
                        <TextValue<b:ResourceIdentityValue i:nil="true"/>
                        <UdfTreatment>A</<b:TextValue>Child of Client C00124</b:TextValue>
                        <b:UdfTreatment>A</b:UdfTreatment>
                        <StoplightValues <b:StoplightValues/>
                        <NumericValue<b:NumericValue i:nil="true"/>
                        <RelationValue<b:RelationValue i:nil="true"/>
                     </b:PwsUserDefinedFieldDetail>
                  </b:UserDefinedFields>
                  <InheritInvoiceEmailSettingsFlag>false<<b:InheritInvoiceEmailSettingsFlag>true</b:InheritInvoiceEmailSettingsFlag>
                  <InvoiceEmailSettings><b:InvoiceEmailSettings>
                     <EmailFromUserIdentity><b:EmailFromUserIdentity>
                        <UserDisplayName>Bettina<b:UserDisplayName>Betty Borces<Smith</b:UserDisplayName>
                        <UserId<b:UserId i:nil="true"/>
                        <UserReferenceSystemId>Partner<b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                        <UserUid>1152921504607011056<<b:UserUid>1152921504607011056</b:UserUid>
                     </b:EmailFromUserIdentity>
                     <EmailInvoiceTemplateIdentity><b:EmailInvoiceTemplateIdentity>
                        <InvoiceTemplateId<b:InvoiceTemplateId i:nil="true"/>
                        <InvoiceTemplateName>E004<<b:InvoiceTemplateName>E004</b:InvoiceTemplateName>
                        <InvoiceTemplateUid>1152921504606878909<<b:InvoiceTemplateUid>1152921504606878909</b:InvoiceTemplateUid>
                     </b:EmailInvoiceTemplateIdentity>
                     <InvoiceEmailEnabledFlag>false<<b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
                     <InvoiceEmailType>P<<b:InvoiceEmailType>W</b:InvoiceEmailType>
                     <Recipients><b:Recipients>
                        <PwsInvoiceEmailRecipient><b:PwsInvoiceEmailRecipient>
                           <RecipientType>T<<b:RecipientType>T</b:RecipientType>
                           <UserIdentity><b:UserIdentity>
                              <UserDisplayName>Jane<b:UserDisplayName>John Doe</b:UserDisplayName>
                              <UserId<b:UserId i:nil="true"/>
                              <UserReferenceSystemId>E124<<b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                              <UserUid>1152921504607112368<<b:UserUid>1152921504607054221</b:UserUid>
                           </b:UserIdentity>
                        </b:PwsInvoiceEmailRecipient>
                     </b:Recipients>
                  </b:InvoiceEmailSettings>
                  <InheritRenderReceiptsFlag>false<<b:InheritRenderReceiptsFlag>true</b:InheritRenderReceiptsFlag>
                  <RenderReceiptsFlag>false<<b:RenderReceiptsFlag>true</b:RenderReceiptsFlag>
                  <AutoApplyAvailableBalanceFlag>false<<b:AutoApplyAvailableBalanceFlag>true</b:AutoApplyAvailableBalanceFlag>
                  <InheritAutoApplyAvailableBalanceFlag>false<<b:InheritAutoApplyAvailableBalanceFlag>true</b:InheritAutoApplyAvailableBalanceFlag>
                  <InheritTaxTypesFlag>false<<b:InheritTaxTypesFlag>true</b:InheritTaxTypesFlag>
                  <TaxType1Identity><b:TaxType1Identity>
                     <TaxTypeCode>VAT<<b:TaxTypeCode>VAT</b:TaxTypeCode>
                     <TaxTypeId<b:TaxTypeId i:nil="true"/>
                     <TaxTypeUid>1152921504606868258<<b:TaxTypeUid>1152921504606868258</b:TaxTypeUid>
                  <//b:TaxType1Identity>
                  <TaxType2Identity<b:TaxType2Identity i:nil="true"/>
                  <TaxType3Identity<b:TaxType3Identity i:nil="true"/>
               </b:ClientDetail>
            </a:Client>
            <ClientIdentity> <a:ClientIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <ClientId<b:ClientId i:nil="true"/>
               <ClientNumber>C001001<<b:ClientNumber>C000127</b:ClientNumber>
               <ClientUid>1152921504606989819<<b:ClientUid>1152921504606998468</b:ClientUid>
            </a:ClientIdentity>
         </PwsSaveClientResult>
      </PwsSaveClientResponse>
   </s:Body>
</s:Envelope>

PwsSaveClient - Common Errors and Warnings

...

ErrorNumberErrorCodeErrorText
105AtLeastOneItemNotFoundAt least one requested item was not found. The remaining items, if any, were returned.
11038NoClientsSpecifiedNo clients were specified for retrieval by this request.
11040MaximumClientIdentitiesExceededPlease specify between 1 and 100 client identities for retrieval.
11042InappropriateStandardRateCardSpecifiedThe specified standard rate card is not appropriate (it is likely an RDC rate card).
50045ViewPermissionDeniedYou do not have permission to view this item.
57631ClientNotSpecifiedA specified client identity was incomplete. Each client identity must specify either a client id, client uid or client number.
57634UnexpectedErrorRetrievingClientsThere was an unexpected error while trying to retrieve a client.

...