Versions Compared

Key

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

...

ElementData TypeRequired?DefaultDescriptionSample Data
RequestIdInt32No
Click here for more information.1
SessionTicketString (50)Yes
Click here for more information.
AcjOqKSXoUYG3qLkrxKQYw==
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 responsetrue/false
ParentClientClearFlagBooleanNofalseValid values include "true" or "false". If set to " true" , null out parent clienttrue/false

Request Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
      <PwsSaveClient>
         <serviceRequest>
            <SessionTicket>AcjOqKSXoUYG3qLkrxKQYw==</SessionTicket>
            <Client>
               <ClientName>Acme 1000-01</ClientName>
               <InactiveFlag>false</InactiveFlag>
               <Address>
                  <AddressLine1>123 Main Street</AddressLine1>
                  <AddressLine2>Suite 100</AddressLine2>
                  <Attention>Jane Smith</Attention>
                  <City>Boston</City>
                  <CompanyName>Acme 1000-01</CompanyName>
                  <Country>USA</Country>
                  <StateOrProvince>MA</StateOrProvince>
                  <ZipOrPostalCode>02114</ZipOrPostalCode>
               </Address>
               <BillingCycleIdentity>
                  <BillingCycleName>Monthly</BillingCycleName>
               </BillingCycleIdentity>
               <BillingInstructions>Bill on the last day of the month</BillingInstructions>
               <ClientMessage>We appreciate your business!</ClientMessage>
               <ClientMessagePlain>We appreciate your business!</ClientMessagePlain>
               <InheritAddressFlag>false</InheritAddressFlag>
               <InheritBillingCycleFlag>false</InheritBillingCycleFlag>
               <InheritBillingInstructionsFlag>false</InheritBillingInstructionsFlag>
               <InheritClientMessageFlag>false</InheritClientMessageFlag>
               <InheritInvoiceContentFlag>false</InheritInvoiceContentFlag>
               <InheritInvoiceScopeFlag>false</InheritInvoiceScopeFlag>
               <InheritInvoiceTemplateFlag>false</InheritInvoiceTemplateFlag>
               <InheritPaymentTermFlag>false</InheritPaymentTermFlag>
               <InheritPurchaseOrderNumberFlag>false</InheritPurchaseOrderNumberFlag>
               <InheritStandardRatesFlag>false</InheritStandardRatesFlag>
               <InheritTimeBillingTypeFlag>false</InheritTimeBillingTypeFlag>
               <InvoiceContent>B</InvoiceContent>
               <InvoiceScope>E</InvoiceScope>
               <InvoiceTemplateIdentity>
                  <InvoiceTemplateName>A200</InvoiceTemplateName>
               </InvoiceTemplateIdentity>
               <NewClientNumber>C001001</NewClientNumber>
               <PaymentTermIdentity>
                  <PaymentTermName>Net 60</PaymentTermName>
               </PaymentTermIdentity>
               <PurchaseOrderNumber>C001000</PurchaseOrderNumber>
               <StandardBillingAdjustedDiscountPercent>0</StandardBillingAdjustedDiscountPercent>
               <StandardContractDiscountPercent>0</StandardContractDiscountPercent>
               <StandardRateCardIdentity>
                  <RateCardName>USA Rate Card</RateCardName>
                  <RateCardType>R</RateCardType>
               </StandardRateCardIdentity>
               <TimeBillingType>H</TimeBillingType>
               <UserDefinedFields>
                  <PwsUserDefinedFieldDetail>
                     <UdfName>Account Owner</UdfName>
                     <DataType>R</DataType>
                     <ResourceIdentityValue>
                        <ResourceDisplayName>Jack Spratt</ResourceDisplayName>
                        <ResourceReferenceSystemId>E123</ResourceReferenceSystemId>
                     </ResourceIdentityValue>
                     <UdfTreatment>A</UdfTreatment>
                  </PwsUserDefinedFieldDetail>
               </UserDefinedFields>
               <InheritInvoiceEmailSettingsFlag>false</InheritInvoiceEmailSettingsFlag>
               <InvoiceEmailSettings>
                  <EmailFromUserIdentity>
                     <UserDisplayName>Bettina Borces</UserDisplayName>
                     <UserReferenceSystemId>Partner - 01</UserReferenceSystemId>
                  </EmailFromUserIdentity>
                  <EmailInvoiceTemplateIdentity>
                     <InvoiceTemplateName>E004</InvoiceTemplateName>
                  </EmailInvoiceTemplateIdentity>
                  <InvoiceEmailEnabledFlag>false</InvoiceEmailEnabledFlag>
                  <InvoiceEmailType>P</InvoiceEmailType>
                  <Recipients>
                     <PwsInvoiceEmailRecipient>
                        <RecipientType>T</RecipientType>
                        <UserIdentity>
                           <UserDisplayName>Jane Doe</UserDisplayName>
                           <UserReferenceSystemId>E124</UserReferenceSystemId>
                        </UserIdentity>
                     </PwsInvoiceEmailRecipient>
                  </Recipients>
               </InvoiceEmailSettings>
               <InheritRenderReceiptsFlag>false</InheritRenderReceiptsFlag>
               <RenderReceiptsFlag>false</RenderReceiptsFlag>
               <AutoApplyAvailableBalanceFlag>false</AutoApplyAvailableBalanceFlag>
               <InheritAutoApplyAvailableBalanceFlag>false</InheritAutoApplyAvailableBalanceFlag>
               <InheritTaxTypesFlag>false</InheritTaxTypesFlag>
               <TaxType1Identity>
                  <TaxTypeCode>VAT</TaxTypeCode>
               </TaxType1Identity>
            </Client>
            <FullDetailFlag>true</FullDetailFlag>
            <ParentClientClearFlag>false</ParentClientClearFlag>
         </serviceRequest>
      </PwsSaveClient>

...

ElementData TypeDescriptionSample Data
MessagesPwsMessageThe web service response status and message
ResponseIdInt32Click here for more information0
StatusStringClick here for more informationOk
ServerTimestampUtcDateTimeClick here for more information
2017-12-27T16:48:52.6790058Z
ClientDetailPwsClientDetail [1]The complete set of information about a client (less any subordinate entities)
ClientIdentityPwsClientRef [1]The unique keys used to identify a client


Response Usage Example(s)

...