Versions Compared

Version Old Version 53 New Version Current
Changes made by

Bettina Borces

Bettina Borces

Saved on

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.

...

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
FullDetailFlagBooleanNofalseIf set to true, include full detailed client element in response
true/false
ParentClientClearFlagBooleanNofalseIf set to true, null out the parent client will be set to null
true/false

Request Usage Example(s)

...

Code Block
languagexml
titleExample 01 - New 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>
      <pws:PwsSaveClient>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQSessionTicket>AVPtg8pZ/KFy3PWleHmQEw==</req:SessionTicket>
            <req:Client>
               <com:ClientName>WebClientName>SOAP ServicesUI Inc.<A</com:ClientName>
               <com:InactiveFlag>false</com:InactiveFlag>
               <com:Address>
                  <com:AddressLine1>123AddressLine1>311 MainSouth Street<Wacker</com:AddressLine1>
                  <com:AddressLine2>Suite 100<2300</com:AddressLine2>
                  <com:Attention>Billing<City>Chicago</com:Attention>City>
                  <com:City>Boston</com:City>CompanyName>SOAP                   <com:CompanyName>Acme Inc.<UI A</com:CompanyName>
                  <com:Country>USA</com:Country>
                  <com:StateOrProvince>MA<StateOrProvince>Illinois</com:StateOrProvince>
                  <com:ZipOrPostalCode>02114<ZipOrPostalCode>60601</com:ZipOrPostalCode>
               </com:Address>
               <com:BillingCycleIdentity>
                  <com:BillingCycleName>Monthly</com:BillingCycleName>
               </com:BillingCycleIdentity>
               <com:BillingInstructions>Please bill onat the last dayend of theeach month.<month</com:BillingInstructions>
               <com:ClientMessage>WeClientMessage>Thank you appreciatefor your business.!</com:ClientMessage>
               <com:ClientMessagePlain>WeClientMessagePlain>Thank you appreciatefor your business.!</com:ClientMessagePlain>
               <com:InheritAddressFlag>false</com:InheritAddressFlag>
               <com:InheritBillingCycleFlag>false</com:InheritBillingCycleFlag>
               <com:InheritBillingInstructionsFlag>false</com:InheritBillingInstructionsFlag>
               <com:InheritClientMessageFlag>false</com:InheritClientMessageFlag>
               <com:InheritInvoiceContentFlag>false</com:InheritInvoiceContentFlag>
               <com:InheritInvoiceScopeFlag>false</com:InheritInvoiceScopeFlag>
               <com:InheritInvoiceTemplateFlag>false</com:InheritInvoiceTemplateFlag>
               <com:InheritPaymentTermFlag>false</com:InheritPaymentTermFlag>
               <com:InheritPurchaseOrderNumberFlag>false</com:InheritPurchaseOrderNumberFlag>
               <com:InheritStandardRatesFlag>false</com:InheritStandardRatesFlag>
               <com:InheritTimeBillingTypeFlag>false</com:InheritTimeBillingTypeFlag>
               <com:InvoiceContent>B</com:InvoiceContent>
               <com:InvoiceScope>E</com:InvoiceScope>
               <com:InvoiceTemplateIdentity>
                  <com:InvoiceTemplateName>A200</com:InvoiceTemplateName>
               </com:InvoiceTemplateIdentity>
               <com:PaymentTermIdentity>
                  <com:PaymentTermName>Net 60<30</com:PaymentTermName>
               </com:PaymentTermIdentity>
               <com:PurchaseOrderNumber>WS-001<PurchaseOrderNumber>SOAP UI</com:PurchaseOrderNumber>
               <com:StandardBillingAdjustedDiscountPercent>15<StandardBillingAdjustedDiscountPercent>10</com:StandardBillingAdjustedDiscountPercent>
               <com:StandardContractDiscountPercent>10<StandardContractDiscountPercent>5</com:StandardContractDiscountPercent>
               <com:StandardRateCardIdentity>
                  <com:RateCardName>USA Rate Card<RateCardName>USA</com:RateCardName>
                  <com:RateCardType>R</com:RateCardType>
               </com:StandardRateCardIdentity>
               <com:TimeBillingType>H</com:TimeBillingType>
               <com:UserDefinedFields>
  :InheritInvoiceEmailSettingsFlag>false</com:InheritInvoiceEmailSettingsFlag>
               <com:PwsUserDefinedFieldDetail>
  InvoiceEmailSettings>
                  <com:UdfName>CL-Text</com:UdfName>EmailFromUserIdentity>
                     <com:TextValue>Created on January 18th, 2018<UserDisplayName>Bettina</com:TextValue>UserDisplayName>
                     <com:UdfTreatment>A<</com:UdfTreatment>EmailFromUserIdentity>
                  </com:PwsUserDefinedFieldDetail><com:EmailInvoiceTemplateIdentity>
                     <<com:InvoiceTemplateName>E002</com:UserDefinedFields>InvoiceTemplateName>
                  <com:InheritInvoiceEmailSettingsFlag>false<</com:InheritInvoiceEmailSettingsFlag>EmailInvoiceTemplateIdentity>
               <com:InvoiceEmailSettings>   <com:InvoiceEmailEnabledFlag>true</com:InvoiceEmailEnabledFlag>
                  <com:InvoiceEmailType>W</com:InvoiceEmailType>
                  <com:EmailFromUserIdentity>Recipients>
                     <com:UserDisplayName>Bob Smith</com:UserDisplayName>PwsInvoiceEmailRecipient>
                        <com:RecipientType>T</com:RecipientType>
                        <com:UserIdentity>
                           <com:UserDisplayName>SOAP UI</com:UserDisplayName>
                        </com:UserIdentity>
                     </com:PwsInvoiceEmailRecipient>
                  </com:Recipients>
               </com:InvoiceEmailSettings>
               <com:InheritRenderReceiptsFlag>false</com:InheritRenderReceiptsFlag>
               <com:RenderReceiptsFlag>false</com:RenderReceiptsFlag>
               <com:AutoApplyAvailableBalanceFlag>false</com:AutoApplyAvailableBalanceFlag>
               <com:InheritAutoApplyAvailableBalanceFlag>false</com:InheritAutoApplyAvailableBalanceFlag>
               <com:InheritTaxTypesFlag>false</com:InheritTaxTypesFlag>
               <com:InheritRenderedInvoiceFormatFlag>false</com:InheritRenderedInvoiceFormatFlag>
               <com:RenderedInvoiceFormat>P</com:RenderedInvoiceFormat>
               <com:Prefix>01312024</com:Prefix>
            </req:Client>
            <req:FullDetailFlag>true</req:FullDetailFlag>
            <req:ParentClientClearFlag>false</req:ParentClientClearFlag>
            <req:DisallowDuplicateNameFlag>false</req:DisallowDuplicateNameFlag>
            <req:FixInheritanceFlag>false</req:FixInheritanceFlag>
         </pws:serviceRequest>
      </pws:PwsSaveClient>
   </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>
      <pws:PwsSaveClient>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AaBd4dMYPbBiEeXoiz50NQ==</req:SessionTicket>
            <req:Client>
               <com:ClientNumber>C000158</com:ClientNumber>
               <com:InactiveFlag>false</com:InactiveFlag>
               <com:Address>
                  <com:AddressLine1>98 North Washington Street</com:AddressLine1>
                  <com:AddressLine2>400</com:AddressLine2>
                  <com:Attention>Office Administrator</com:Attention>
                  <com:City>Boston</com:City>
                  <com:CompanyName>Projector PSA</com:CompanyName>
                  <com:Country>USA</com:Country>
                  <com:StateOrProvince>MA</com:StateOrProvince>
                  <com:ZipOrPostalCode>02114</com:ZipOrPostalCode>
               </com:Address>
               <com:BillingCycleIdentity>
                  <com:BillingCycleName>Monthly</com:BillingCycleName>
               </com:BillingCycleIdentity>
               <com:BillingInstructions>Please bill on the last day of the month.</com:BillingInstructions>
               <com:ClientMessage>We appreciate your business.</com:ClientMessage>
               <com:ClientMessagePlain>We appreciate your business.</com:ClientMessagePlain>
               <com:InheritAddressFlag>false</com:InheritAddressFlag>
               <com:InheritBillingCycleFlag>false</com:InheritBillingCycleFlag>
               <com:InheritBillingInstructionsFlag>false</com:InheritBillingInstructionsFlag>
               <com:InheritClientMessageFlag>false</com:InheritClientMessageFlag>
               <com:InheritInvoiceContentFlag>false</com:InheritInvoiceContentFlag>
               <com:InheritInvoiceScopeFlag>false</com:InheritInvoiceScopeFlag>
               <com:InheritInvoiceTemplateFlag>false</com:InheritInvoiceTemplateFlag>
               <com:InheritPaymentTermFlag>false</com:InheritPaymentTermFlag>
               <com:InheritPurchaseOrderNumberFlag>false</com:InheritPurchaseOrderNumberFlag>
               <com:InheritStandardRatesFlag>false</com:InheritStandardRatesFlag>
               <com:InheritTimeBillingTypeFlag>false</com:InheritTimeBillingTypeFlag>
               <com:InvoiceContent>B</com:InvoiceContent>
               <com:InvoiceScope>E</com:InvoiceScope>
               <com:InvoiceTemplateIdentity>
                  <com:InvoiceTemplateName>A200</com:InvoiceTemplateName>
               </com:InvoiceTemplateIdentity>
               <com:PaymentTermIdentity>
                  <com:PaymentTermName>Net 30</com:PaymentTermName>
               </com:PaymentTermIdentity>
               <com:PurchaseOrderNumber>PPSA</com:PurchaseOrderNumber>
               <com:StandardBillingAdjustedDiscountPercent>15</com:StandardBillingAdjustedDiscountPercent>
               <com:StandardContractDiscountPercent>10</com:StandardContractDiscountPercent>
               <com:StandardRateCardIdentity>
                  <com:RateCardName>USA</com:RateCardName>
                  <com:RateCardType>R</com:RateCardType>
               </com:StandardRateCardIdentity>
               <com:TimeBillingType>H</com:TimeBillingType>
               <com:UserDefinedFields>
                  <com:PwsUserDefinedFieldDetail>
                     <com:UdfName>CL-Text</com:UdfName>
                     <com:TextValue>Updated on November 6th, 2023</com:TextValue>
                  </com:PwsUserDefinedFieldDetail>
               </com:UserDefinedFields>
               <com:InheritInvoiceEmailSettingsFlag>false</com:InheritInvoiceEmailSettingsFlag>
               <com:InvoiceEmailSettings>
                  <com:EmailFromUserIdentity>
                     <com:UserReferenceSystemId>Partner - 01<UserDisplayName>Bettina</com:UserReferenceSystemId>UserDisplayName>
                  </com:EmailFromUserIdentity>
                  <com:EmailInvoiceTemplateIdentity>
                     <com:InvoiceTemplateName>E004<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>JohnUserDisplayName>Template Doe<Client</com:UserDisplayName>
                           <com:UserReferenceSystemId>E123<</com:UserReferenceSystemId>UserIdentity>
                        </com:UserIdentity>
  PwsInvoiceEmailRecipient>
                  </com:PwsInvoiceEmailRecipient>
  Recipients>
               </com:Recipients>InvoiceEmailSettings>
               <<com:InheritRenderReceiptsFlag>false</com:InvoiceEmailSettings>InheritRenderReceiptsFlag>
               <com:InheritRenderReceiptsFlag>false<RenderReceiptsFlag>true</com:InheritRenderReceiptsFlag>RenderReceiptsFlag>
               <com:RenderReceiptsFlag>true<AutoApplyAvailableBalanceFlag>false</com:RenderReceiptsFlag>AutoApplyAvailableBalanceFlag>
               <com:AutoApplyAvailableBalanceFlag>true<InheritAutoApplyAvailableBalanceFlag>false</com:AutoApplyAvailableBalanceFlag>InheritAutoApplyAvailableBalanceFlag>
               <com:InheritAutoApplyAvailableBalanceFlag>false<InheritTaxTypesFlag>true</com:InheritAutoApplyAvailableBalanceFlag>InheritTaxTypesFlag>
               <com:InheritTaxTypesFlag>false<InheritRenderedInvoiceFormatFlag>false</com:InheritTaxTypesFlag>InheritRenderedInvoiceFormatFlag>
               <com:TaxType1Identity>
  :RenderedInvoiceFormat>P</com:RenderedInvoiceFormat>
               <com:TaxTypeCode>VAT<Prefix>11062023</com:TaxTypeCode>Prefix>
            </req:Client>
            <<req:FullDetailFlag>true</comreq:TaxType1Identity>FullDetailFlag>
            <<req:ParentClientClearFlag>false</req:Client>ParentClientClearFlag>
            <req:FullDetailFlag>true<DisallowDuplicateNameFlag>true</req:FullDetailFlag>DisallowDuplicateNameFlag>
            <req:ParentClientClearFlag>false<FixInheritanceFlag>false</req:ParentClientClearFlag>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>

...

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
StatusStringRequestStatusClick here for more informationOk
ServerTimestampUtcDateTimeClick here for more information
2017-12-27T16:48:52.6790058Z
ClientDetailPwsClientDetail [1]ClientPwsClientElementThe complete set of information about a client (less any subordinate entities)the client
ClientIdentityPwsClientRef [1]The unique keys used to identify a the client

Response Usage Example(s)

...

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.

...